diff options
| author | Junio C Hamano <gitster@pobox.com> | 2024-03-01 14:38:55 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2024-03-01 14:38:55 -0800 |
| commit | 9ce1ca304581163b5e35e380384b3bfc232d6f89 (patch) | |
| tree | 1f0afd68fda0f7193b1137700e32af1a097632bc /Documentation/CodingGuidelines | |
| parent | 510a27e9e48ae13ebf94a71041878445aba29f8c (diff) | |
| parent | 0824639ddf9c8ea9d7857440fb2414e12349f51a (diff) | |
| download | git-9ce1ca304581163b5e35e380384b3bfc232d6f89.tar.gz | |
Merge branch 'ja/doc-placeholders-markup-rules' into HEAD
The way placeholders are to be marked-up in documentation have been
specified; use "_<placeholder>_" to typeset the word inside a pair
of <angle-brakets> emphasized.
* ja/doc-placeholders-markup-rules:
doc: clarify the format of placeholders
Diffstat (limited to 'Documentation/CodingGuidelines')
| -rw-r--r-- | Documentation/CodingGuidelines | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 578587a471..a6a965609b 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -666,6 +666,11 @@ Writing Documentation: <new-branch-name> --template=<template-directory> + When a placeholder is cited in text paragraph, it is enclosed in angle + brackets to remind the reader the reference in the synopsis section. + For better visibility, the placeholder is typeset in italics: + The _<file>_ to be added. + Possibility of multiple occurrences is indicated by three dots: <file>... (One or more of <file>.) @@ -751,6 +756,8 @@ Writing Documentation: Incorrect: `\--pretty=oneline` +A placeholder is not enclosed in backticks, as it is not a literal. + If some place in the documentation needs to typeset a command usage example with inline substitutions, it is fine to use +monospaced and inline substituted text+ instead of `monospaced literal text`, and with |