mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'ja/doc-placeholders-markup-rules' into HEAD

Browse Source 
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
This commit is contained in:
Junio C Hamano
2024-03-01 14:38:55 -08:00
parent 510a27e9e4 0824639ddf
commit 9ce1ca3045
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/CodingGuidelines
View File

@ -666,6 +666,11 @@ Writing Documentation:
<new-branch-name> <new-branch-name>
--template=<template-directory> --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: Possibility of multiple occurrences is indicated by three dots:
<file>... <file>...
(One or more of <file>.) (One or more of <file>.)
@ -751,6 +756,8 @@ Writing Documentation:
Incorrect: Incorrect:
`\--pretty=oneline` `\--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 If some place in the documentation needs to typeset a command usage
example with inline substitutions, it is fine to use +monospaced and example with inline substitutions, it is fine to use +monospaced and
inline substituted text+ instead of `monospaced literal text`, and with inline substituted text+ instead of `monospaced literal text`, and with