Skip to content

Commit 7d66ac6

Browse files
committed
Fix spelling in documentation article
1 parent 63a2bfc commit 7d66ac6

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/writing/documentation.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ When striving for coding excellence, it is useful to see any existing comment,
7878
or any feeling of a need for a comment, as the sign that the code do not
7979
express clearly enough its intent and can be improved.
8080

81-
**.. but no code is perfect.** Perfect code is a chimere, it exists only in
81+
**.. but no code is perfect.** Perfect code is a chimera, it exists only in
8282
our dreams. In real life, a code base is full of trade offs, and comments are
8383
often needed in the most difficult parts. Moreover, any special case, any
8484
obscure hack, any monkey patch and any ugly workaround MUST be signaled and
@@ -87,15 +87,15 @@ explained by a proper comment. This should be enforced by the law!
8787
**TODOs** are special comments that a developer write as a reminder for later
8888
use. It is said that its original intent was that someone might, one day,
8989
search for the string "TODO" in the code base and actually roll their sleeves
90-
and start *to do the TODOs*. There is no avalaible record that it ever
90+
and start *to do the TODOs*. There is no available record that it ever
9191
happened. However, TODOs comment are still very useful, because they mark the
9292
current limits of the code, and it is not unlikely that, when required to add a
9393
new behavior to the actual code, looking at the TODOs will show where to start.
9494

9595
**Do not use triple-quote strings to comment code.** A common operation when
96-
modifiying code is to comment out some lines or even a full function or class
96+
modifying code is to comment out some lines or even a full function or class
9797
definition. This can be done by adding triple-quotes around the code block to
98-
be skipped, but this is not a good pratice, because line-oriented command-line
98+
be skipped, but this is not a good practice, because line-oriented command-line
9999
tools such as ``grep`` will not be aware that the commented code is inactive.
100100
It is better to add hashes at the proper indentation level for every commented
101101
line. Good editors allow to do this with few keystrokes (ctrl-v on Vim).
@@ -156,7 +156,7 @@ Block comment styling should be used when commenting out multiple lines of code.
156156
Paragraphs inside a block comment are separated by a line containing a
157157
single #.
158158

159-
Inline comments are used for individual lines and should be used sparingly.: ::
159+
In-line comments are used for individual lines and should be used sparingly.: ::
160160

161161
An inline comment is a comment on the same line as a statement. Inline
162162
comments should be separated by at least two spaces from the statement.

0 commit comments

Comments
 (0)