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

style-guide: modify grouping placeholders section #11723

Merged
merged 1 commit into from
Dec 12, 2023

Conversation

gutjuri
Copy link
Member

@gutjuri gutjuri commented Dec 11, 2023

We have multiple pages where more than 5 possible argument values are separated with |. (e.g. here)
However, the style-guide currently states that if there are more than 5 possible values, we should use ... after the last (5th?) item.
As this is 1. not how we do things in practice and 2. too restrictive (e.g. if there are 6 possible values, you'd be forced to write ... INSTEAD of the last value), I propose to change this from a hard rule to a recommendation.

Also, #11146 has a checkbox that is somehow related (Document how multiple examples can be concatenated and separated with |)

@github-actions github-actions bot added the documentation Issues/PRs modifying the documentation. label Dec 11, 2023
@kbdharun kbdharun added the minor change Change(s) to an existing page(s) which is minor. label Dec 11, 2023
@kbdharun kbdharun changed the title style-guide: modify page style-guide: modify grouping placeholders section Dec 11, 2023
@sebastiaanspeck sebastiaanspeck merged commit f9606bb into tldr-pages:main Dec 12, 2023
@gutjuri gutjuri deleted the fix-placehilders branch December 12, 2023 06:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues/PRs modifying the documentation. minor change Change(s) to an existing page(s) which is minor.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants