From 04a78338e72831d669ea52ade514061ab9b0caaa Mon Sep 17 00:00:00 2001 From: FantasyCookie17 Date: Thu, 15 Apr 2021 19:16:25 +0200 Subject: [PATCH] CONTRIBUTING: improve wording about example count limit (#5760) --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58dacea50..5ec9f3ed0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.