-
Notifications
You must be signed in to change notification settings - Fork 37
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
Plural or singular names for nested data types #483
Comments
Copying the relevant comment of @rartino for context: My personal preference (which perhaps comes a bit from a programmer-first perspective) is to not mess around with pluralization in a declarative statement like this, just use the type name as we have defined them. So, for the above IMO it should be "Array of Object". However, in the bulk text where one uses full sentences I would write, e.g., "The value should be an array of objects". But I don't feel very strongly either way, so if no one backs me up on this view, <...>. Originally posted by @rartino in #480 (comment) |
After some though, I am probably with @JPBergsma on this one. Since the specification is mainly intended for a human reader, the full plural does seem a bit nicer. My priority list:
|
To clarify my position a little bit:
But, if we go with |
I think that it would be nice if you could make it "Type: list of lists of floats". |
We have discussed this further during the online optimade meeting on the 25th of August. |
During the discussion on PR#480, the issue came up that it was not clear how the data type of fields with nested values should be described. In the text, we seem to always use the plural form, e.g. list of lists of integers. But in the type field of the attribute descriptions, we sometimes use the singular form like "list of list of float" instead of the plural form "list of lists of floats".
To be consistent, it would be good to use one form consistently.
My preference would be to use the plural form, but @rartino prefers the singular form.
I am therefore curious to hear what the opinions of others are.
Some more examples from the specification:
line 2113: query-support-operators: List of Strings
2537: - Type: list of strings
2583: list of floats
2717: list of integers
2757: list of list of floats
2811: list of list of floats
2848: list of strings
2871: list of dictionary
The text was updated successfully, but these errors were encountered: