openstack/swift
Code Issues Proposed changes

Minor dev guidelines formatting fixes

Browse Source 
Change-Id: I650bc69bed98ac3cd45c79caaf4007d713e21fd9
This commit is contained in:
Tim Burke 2017-01-19 16:53:35 -08:00
parent fab96ed11a
commit c4d455ca03
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/source/development_guidelines.rst
View File

@ -203,19 +203,20 @@ The documentation in docstrings should follow the PEP 257 conventions
More specifically:
1. Triple quotes should be used for all docstrings.
2. If the docstring is simple and fits on one line, then just use
one line.
3. For docstrings that take multiple lines, there should be a newline
after the opening quotes, and before the closing quotes.
4. Sphinx is used to build documentation, so use the restructured text
markup to designate parameters, return values, etc. Documentation on
the sphinx specific markup can be found here:
http://sphinx.pocoo.org/markup/index.html
#. Triple quotes should be used for all docstrings.
#. If the docstring is simple and fits on one line, then just use
one line.
#. For docstrings that take multiple lines, there should be a newline
after the opening quotes, and before the closing quotes.
#. Sphinx is used to build documentation, so use the restructured text
markup to designate parameters, return values, etc. Documentation on
the sphinx specific markup can be found here:
http://sphinx.pocoo.org/markup/index.html
Installing Sphinx:
#. Install sphinx (On Ubuntu: `sudo apt-get install python-sphinx`)
#. `python setup.py build_sphinx`
#. Install sphinx (On Ubuntu: ``sudo apt-get install python-sphinx``)
#. ``python setup.py build_sphinx``
--------
Manpages