From 203b92ce617411ed65f9ad4a7c475c14690b83e0 Mon Sep 17 00:00:00 2001 From: ugurthemaster Date: Mon, 25 Nov 2013 11:05:54 +0200 Subject: [PATCH] Update documentation.rst --- docs/writing/documentation.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst index d543f53..7793af4 100644 --- a/docs/writing/documentation.rst +++ b/docs/writing/documentation.rst @@ -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: