-
-
Notifications
You must be signed in to change notification settings - Fork 30k
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
Inconsistent format to list attributes in Data Model section #111746
Comments
Screenshots:
Standardising can help, although I wouldn't say it must be done, but we should pick the best tool to present the information in each case. I agree the inline ones need changing (Google calls these "embedded" or "run-in" lists and recommends transforming into bulleted or numbered lists: https://developers.google.com/tech-writing/one/lists-and-tables). For accessibility, this 2012 article recommends tables over definition lists (which is what example 2 is): However, this 2022 post says support for definition lists is generally good, and this 2017 says tables are OK too:
So let's compare what info is being conveyed in these three examples. The table of "special attributes" has three columns:
The definition list has "predefined (writable) attributes":
Followed by a single "special read-only attribute":
These could be combined into a single table, but I'm not entirely clear on the difference between "predefined (writable)" and "special read-only". Finally, the inline descriptions are all "special read-only attributes":
I guess a definition list would suffice for those with just two headers, although tables are a more compact, and it's a problem that this page is already so long. What do you think? If we go for tables, I suggest using |
Thanks for the deep analysis, @hugovk . In this case, I think a table is more suitable. |
Would you like to put together a PR? Feel free to do them one at a time, if it's easier. |
At some moment in the future, I can do that. However, if somebody more available wants to do this, go ahead. |
Documentation
Object attributes are listed several times in the Data Model section. However, there is no standard format.
It was used:
It must be standardized. But what will be the choice? In line is the worst. It is not a choice.
But about table or list?
Linked PRs
The text was updated successfully, but these errors were encountered: