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

Update documentation.rst

Browse Source
This commit is contained in:
ugurthemaster
2013-11-25 11:05:54 +02:00
parent 3f7fb5e756
commit 203b92ce61
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/writing/documentation.rst
+3 -1
View File
@@ -94,7 +94,9 @@ Reference`_ should help you familiarize yourself with its syntax.
Code Documentation Advice
-------------------------
Comments clarify code and begin with a hash (``#``).
Comments clarify the code and they are added with purpose of making the
code easier to understand. In Python, comments begin with a hash
(number sign) (``#``).
.. _docstring-ref: