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

Merge branch 'yd/doc-is-in-asciidoc'

Browse Source 
* yd/doc-is-in-asciidoc:
  CodingGuidelines: our documents are in AsciiDoc
This commit is contained in:
Junio C Hamano 2013-03-28 14:38:20 -07:00
commit f893be2712
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/CodingGuidelines
View File

@ -237,6 +237,9 @@ For Python scripts:
Writing Documentation: Writing Documentation:
Most (if not all) of the documentation pages are written in AsciiDoc
and processed into HTML output and manpages.
Every user-visible change should be reflected in the documentation. Every user-visible change should be reflected in the documentation.
The same general rule as for code applies -- imitate the existing The same general rule as for code applies -- imitate the existing
conventions. A few commented examples follow to provide reference conventions. A few commented examples follow to provide reference