[New-bugs-announce] [issue3983] Typos in Documentation

Bk report at bugs.python.org
Sun Sep 28 10:50:49 CEST 2008

New submission from Bk <jurevesel2 at gmail.com>:


I would like to contribute to the development of the Python
documentation so I am reporting two typos. The first one is in the
documentation and the second one is in the module ntpath.

1) There's a typo under "The Python Tutorial" > "Using the Python
Interpreter" > "Invoking the Interpreter". The sentence with the typo is
positioned almost at the top, and starts like this:
"On Windows machines, the Python installation is usually placed in
C:Python30 ..."

The above text lacks a backslash in the path "C:Python30". Please add a
backslash to this path so that it would be written as "C:\Python30". The
text should be written like this:
"On Windows machines, the Python installation is usually placed in
C:\Python30 ..."

2) Please take a look at the source code of the module ntpath. The line
63 has a typo in the comment:
# set to 1 iff b makes path irrelevant

which should be
# set to 1 if b makes path irrelevant

Please note that the word 'iff' is fixed to 'if'.

Maybe just two little questions at the end... Please see the source code
of the module ntpath and note the line 72. Since the word in the comment
(i.e. 'But') is a continuation of the same sentence, doesn't it suppose
to be written with the lower-case initial as 'but'?

And also, why do some comments in modules start with the lower-case
initial and end without the dot, and others with the upper-case initial
and end with a dot? It would be nice if those things would be
conventionalized. I really don't understand when a comment must be
written as a sentence with its full orthographical rules. Please explain.

assignee: georg.brandl
components: Documentation
messages: 73960
nosy: Bk, georg.brandl
severity: normal
status: open
title: Typos in Documentation
versions: Python 3.0, Python 3.1

Python tracker <report at bugs.python.org>

More information about the New-bugs-announce mailing list