summaryrefslogtreecommitdiffstats
path: root/doc/development/docstyleguide.txt
diff options
context:
space:
mode:
authorJack Neely <jjneely@ncsu.edu>2011-06-10 13:29:23 -0400
committerJack Neely <jjneely@ncsu.edu>2011-06-10 13:29:23 -0400
commit90c85147bacea14771abf8faa1fc5f185418d14b (patch)
treeb10e06fc80ed714f5376b169e32b8953479211f1 /doc/development/docstyleguide.txt
parent4f3da4543ec4e8c3c4776ae2ee3611e47ce78525 (diff)
parentce6a228d33ace4136dc2b5388c64795dfbd26ffb (diff)
downloadbcfg2-90c85147bacea14771abf8faa1fc5f185418d14b.tar.gz
bcfg2-90c85147bacea14771abf8faa1fc5f185418d14b.tar.bz2
bcfg2-90c85147bacea14771abf8faa1fc5f185418d14b.zip
Merge branch 'master' of github.com:solj/bcfg2
Diffstat (limited to 'doc/development/docstyleguide.txt')
-rw-r--r--doc/development/docstyleguide.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/development/docstyleguide.txt b/doc/development/docstyleguide.txt
index fda1037f3..59db58362 100644
--- a/doc/development/docstyleguide.txt
+++ b/doc/development/docstyleguide.txt
@@ -25,3 +25,9 @@ Basics
When used alone this refers to a Bcfg2 :term:`repository`. When there
is a chance for confusion, for instance in documents also talking
about :term:`VCS`, be sure to use the longer Bcfg2 :term:`repository`.
+
+Sections
+--------
+
+Unless necessary, all the documentation follows the sections header
+rules available at http://docs.python.org/documenting/rest.html#sections.