git://git.eng.unimelb.edu.au
/
python-guide.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
| inline |
side by side
(parent:
89f9147
)
Make the inline link to docstrings work.
author
Niko Wenselowski
<der@nik0.de>
Sat, 12 May 2012 20:05:31 +0000
(22:05 +0200)
committer
Niko Wenselowski
<der@nik0.de>
Sat, 12 May 2012 20:05:31 +0000
(22:05 +0200)
docs/writing/documentation.rst
patch
|
blob
|
history
diff --git
a/docs/writing/documentation.rst
b/docs/writing/documentation.rst
index
514197a
..
e469439
100644
(file)
--- a/
docs/writing/documentation.rst
+++ b/
docs/writing/documentation.rst
@@
-55,6
+55,8
@@
Comments
Comments are written directly inside the code, either using the hash sign (#)
or a docstring_.
+.. _docstring: docstrings_
+
Finding the correct balance between undocumented code and verbose and useless
comment boilerplates is difficult, and is the subject of heated discussion
among developers.