]> git.ipfire.org Git - thirdparty/git.git/commit
advice: make all entries stylistically consistent
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Tue, 5 Mar 2024 20:29:40 +0000 (21:29 +0100)
committerJunio C Hamano <gitster@pobox.com>
Tue, 5 Mar 2024 21:04:25 +0000 (13:04 -0800)
commit95c987e6fad7cd3b3fe57542dbc6fb91532642d8
tree7f0d6276d73b4f252e98a101c32665d31ddeee8e
parent8c5001c68e8f768e7b97cb5c366bc0b1e7a31ba7
advice: make all entries stylistically consistent

In general, rewrite entries to the following form:

1. Clause or sentence describing when the advice is shown
2. Optional “to <verb>” clause which says what the advice is
   about (e.g. for resetNoRefresh: tell the user that they can use
   `--no-refresh`)

Concretely:

1. Use “shown” instead of “advice shown”
   • “advice” is implied and a bit repetitive
2. Use “when” instead of “if”
3. Lead with “Shown when” and end the entry with the effect it has,
   where applicable
4. Use “the user” instead of “a user” or “you”
5. implicitIdentity: rewrite description in order to lead with *when*
   the advice is shown (see point (3))
6. Prefer the present tense (with the exception of pushNonFFMatching)
7. waitingForEditor: give example of relevance in this new context
8. pushUpdateRejected: exception to the above principles

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/advice.txt