We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 3f7fb5e commit 203b92cCopy full SHA for 203b92c
1 file changed
docs/writing/documentation.rst
@@ -94,7 +94,9 @@ Reference`_ should help you familiarize yourself with its syntax.
94
Code Documentation Advice
95
-------------------------
96
97
-Comments clarify code and begin with a hash (``#``).
+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) (``#``).
100
101
.. _docstring-ref:
102
0 commit comments