mirror of
https://github.com/tldr-pages/tldr.git
synced 2024-09-11 12:05:35 +03:00
CONTRIBUTING: improve wording about example count limit (#5760)
This commit is contained in:
parent
5b399da211
commit
04a78338e7
@ -30,7 +30,7 @@ To get started, please [sign](https://cla-assistant.io/tldr-pages/tldr) the
|
||||
The basic format of a `tldr` page is a set of concrete usage examples.
|
||||
Here are a few guidelines to get started:
|
||||
|
||||
1. Try to keep pages at around 5 examples. Pages can be longer if needed, but don't exceed 8 examples.
|
||||
1. Try to keep pages at around 5 examples. Pages can be longer or shorter when appropriate, but don't exceed 8 examples.
|
||||
Remember, it's OK if the page doesn't cover everything; that's what `man` is for.
|
||||
2. When in doubt, keep new command-line users in mind. Err on the side of clarity rather than terseness.
|
||||
For example, commands that require `sudo` should include it directly in the examples.
|
||||
|
Loading…
Reference in New Issue
Block a user