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

Use the :pep: tag instead of directly linking PEPs

Browse Source
This commit is contained in:
kuyan
2013-07-30 13:05:56 -07:00
parent cbcbce56c8
commit b6f014342d
10 changed files with 25 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/writing/documentation.rst
+2 -6
View File
@@ -104,9 +104,7 @@ In Python, *docstrings* describe modules, classes, and functions: ::
"""Returns the square root of self times self."""
...
In general, follow the `comment section of PEP 0008`_ (the "Python Style Guide").
.. _comment section of PEP 0008: http://www.python.org/dev/peps/pep-0008/#comments
In general, follow the comment section of :pep:`8#comments` (the "Python Style Guide").
Commenting Sections of Code
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -137,9 +135,7 @@ operation of the function or class: ::
"""Returns the square root of self times self."""
...
.. seealso:: Further reading on docstrings: `PEP 0257`_
.. _PEP 0257: http://www.python.org/dev/peps/pep-0257/
.. seealso:: Further reading on docstrings: :pep:`257`
Other Tools