kennethreitz/python-guide
1
0
Fork 0
mirror of https://github.com/kennethreitz/python-guide.git synced 2026-06-05 14:50:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed the urls pointing to contribute and fixed some lines that were

Browse Source 
longer than 78 characters.
This commit is contained in:
Vincent Zee
2015-02-28 22:23:07 +01:00
parent d6c2c8d16d
commit 5aac29d245
5 changed files with 20 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/writing/documentation.rst
+6 -5
View File
@@ -40,12 +40,12 @@ of the following components:
done with the product, using one or two extremely simplified use
cases. This is the thirty-second pitch for your project.
- A *tutorial* should show some primary use cases in more detail. The reader will
follow a step-by-step procedure to set-up a working prototype.
- A *tutorial* should show some primary use cases in more detail. The reader
will follow a step-by-step procedure to set-up a working prototype.
- An *API reference* is typically generated from the code (see
:ref:`docstrings <docstring-ref>`). It will list all publicly available interfaces,
parameters, and return values.
:ref:`docstrings <docstring-ref>`). It will list all publicly available
interfaces, parameters, and return values.
- *Developer documentation* is intended for potential contributors. This can
include code convention and general design strategy of the project.
@@ -107,7 +107,8 @@ In Python, *docstrings* describe modules, classes, and functions:
"""Returns the square root of self times self."""
...
In general, follow the comment section of :pep:`8#comments` (the "Python Style Guide").
In general, follow the comment section of :pep:`8#comments` (the "Python Style
Guide").
Commenting Sections of Code
~~~~~~~~~~~~~~~~~~~~~~~~~~~