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.

Sign up for GitHub

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

Jump to bottom

Fix "Example descriptions" section in style-guide #15926

Open

Managor opened this issue Mar 12, 2025 · 0 comments

Collaborator

Managor commented Mar 12, 2025

In the example descriptions there are various inconsistencies. It advices not to use the command name in the description while using it in the preferred examples.
The section also contains information that should be in the heading section. This section is for the descriptions of the example commands.
https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#example-descriptions

The heading sections should also give instructions when the page needs clarification of what the brand name of a command is like in https://github.com/tldr-pages/tldr/pull/15873/files and https://github.com/tldr-pages/tldr/pull/15888/files

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment