diff options
| author | Jenkins <jenkins@review.openstack.org> | 2015-07-07 06:31:10 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2015-07-07 06:31:10 +0000 |
| commit | c5cc43a5beacb7c1d3e147f3654fdea207e8340a (patch) | |
| tree | 86d10fcd9c91f8a1d0e531944931b74f20254899 | |
| parent | 276603835d97fcca8508d568b026e1ccc352e4fe (diff) | |
| parent | 868ea6a9678fbdb4819673869bc9e045cfc6d313 (diff) | |
| download | pbr-c5cc43a5beacb7c1d3e147f3654fdea207e8340a.tar.gz | |
Merge "This documents the use of comments that work between 2.6, 2.7 and 3.4"
| -rw-r--r-- | doc/source/index.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 331a2d3..b9e49eb 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -305,6 +305,22 @@ all found Python modules are included; some of them can be excluded by listing them in `autodoc_exclude_modules`. This list of modules can contains `fnmatch` style pattern (e.g. `myapp.tests.*`) to exclude some modules. +Comments +-------- + +Comments may be used in setup.cfg, however all comments should start with a +`#` and may be on a single line, or in line, with at least one white space +character immediately preceding the `#`. Semicolons are not a supported +comment delimiter. For instance:: + + [section] + # A comment at the start of a dedicated line + key = + value1 # An in line comment + value2 + # A comment on a dedicated line + value3 + Additional Docs =============== |