General - Make type syntax in header more consitent #10681
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When merged this pull request will:
s
for plural of typeor
for multiple optionsBOOLEAN
->BOOL
,POSITION
->ARRAY
)<OPTIONAL>
with(default: ...)
IMPORTANT
Component - Add|Fix|Improve|Change|Make|Remove {changes}
.Discussion
Nested types
Currently, there are two syntax versions of how the types inside an array are represented:
ARRAY<NUMBER>
,ARRAY<ARRAY<OBJECT, NUMBER>>
ARRAY of ARRAYs of OBJECTs and NUMBERs
Which syntax should be used?
Enclosure
Furthermore, should each type be enclosed in their own
<TYPE>
when multiple types are an options?<CODE or STRING>
<CODE> or <STRING>
Plural
Should types be pluralized? If so, how?
<ARRAY of NUMBER>
<ARRAY of NUMBERs>
<ARRAY of NUMBERS>