Skip to content
This repository was archived by the owner on Dec 11, 2025. It is now read-only.

Change some wording in the documentation. #1

Open
BeEdward wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Change some wording in the documentation. #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/source/schema/basic_syntax.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ Portex provides the basic key ``type``. Its value means the type of data and pre
string. The bulitin supported types can be found in :doc:`/schema/primitive_types` and
:doc:`/schema/complex_types/index`.

The most important feature of Portex is that the type is configurable, different types has different
parameters.
The most important feature of Portex is that types are composable, complex types can be assembled with other types that have already been definited.
Copy link
Contributor

@linjiX linjiX May 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think configurable has a larger scope than composable? And here I think the configurable is more accurate to describe Portex types. You can find the configurable related info in https://openbytes-schema.readthedocs.io/en/latest/schema/template_type.html


For example, the :doc:`/schema/complex_types/enum` type has parameters ``values`` to indicate the
possible values of the enum.
Expand Down