Skip to content

Commit 203b92c

Browse files
author
ugurthemaster
committed
Update documentation.rst
1 parent 3f7fb5e commit 203b92c

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/writing/documentation.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,9 @@ Reference`_ should help you familiarize yourself with its syntax.
9494
Code Documentation Advice
9595
-------------------------
9696

97-
Comments clarify code and begin with a hash (``#``).
97+
Comments clarify the code and they are added with purpose of making the
98+
code easier to understand. In Python, comments begin with a hash
99+
(number sign) (``#``).
98100

99101
.. _docstring-ref:
100102

0 commit comments

Comments
 (0)