Typos in Documentation

[Bk]

BPO	3983
Nosy	@birkenfeld

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/birkenfeld'
closed_at = <Date 2008-09-28.09:12:44.447>
created_at = <Date 2008-09-28.08:50:48.984>
labels = ['docs']
title = 'Typos in Documentation'
updated_at = <Date 2008-09-28.09:12:44.446>
user = 'https://bugs.python.org/Bk'

bugs.python.org fields:

activity = <Date 2008-09-28.09:12:44.446>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2008-09-28.09:12:44.447>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2008-09-28.08:50:48.984>
creator = 'Bk'
dependencies = []
files = []
hgrepos = []
issue_num = 3983
keywords = []
message_count = 2.0
messages = ['73960', '73962']
nosy_count = 2.0
nosy_names = ['georg.brandl', 'Bk']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue3983'
versions = ['Python 3.0', 'Python 3.1']

[Bk]

Hello,

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.

[birkenfeld]

Fixed typo 1) in r66669, thanks for that. For 2), "iff" is a usual
abbreviation for "if and only if".

About your two questions, comments in modules are written in whatever
way the author likes to write his comments. There are no rules for that,
other than that a comment should explain the code it comments on. (PEP-8
has some examples of unhelpful comments.)