Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General - Make type syntax in header more consitent #10681

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

Timi007
Copy link
Contributor

@Timi007 Timi007 commented Jan 20, 2025

When merged this pull request will:

  • Make type syntax in header more consitent
  • Make all types UPPERCASE
  • Append lowercase s for plural of type
  • Use or for multiple options
  • Unify types (e.g., BOOLEAN -> BOOL, POSITION -> ARRAY)
  • Unify optional argument syntax
  • Fix some spelling
  • Replace <OPTIONAL> with (default: ...)

IMPORTANT

  • If the contribution affects the documentation, please include your changes in this pull request so the documentation will appear on the website.
  • Development Guidelines are read, understood and applied.
  • Title of this PR uses our standard template 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:

  1. ARRAY<NUMBER>, ARRAY<ARRAY<OBJECT, NUMBER>>
  2. 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?

  1. <CODE or STRING>
  2. <CODE> or <STRING>

Plural

Should types be pluralized? If so, how?

  1. No plural: <ARRAY of NUMBER>
  2. Plural, lowercase s: <ARRAY of NUMBERs>
  3. Plural, uppercase S: <ARRAY of NUMBERS>

@Andx667
Copy link
Contributor

Andx667 commented Jan 21, 2025

My thoughts on the discussion:

Nested types
ARRAY<NUMBER>, ARRAY<ARRAY<OBJECT, NUMBER>> seems precise and unambiguous to me.

Enclosure
<CODE> or <STRING> is my favorite here. It's consistent with the other types because its always <type> not < something or something>

Plural
I'm kinda torn on this. Keeping with the consistency argument from before I would choose no plural. But I feel that the added s make it's a lot more clear what is meant.

No plural: <ARRAY of NUMBER>

Plural, uppercase S: <ARRAY of NUMBERS>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants