This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Missing 2 hyphens in the docs
Type: Stage:
Components: Documentation Versions: Python 3.2, Python 3.3, Python 3.4
process
Status: closed Resolution: wont fix
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Retro, benjamin.peterson, docs@python, eli.bendersky, georg.brandl, rhettinger
Priority: normal Keywords:

Created on 2011-04-09 08:36 by Retro, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (9)
msg133377 - (view) Author: Boštjan Mejak (Retro) Date: 2011-04-09 08:36
Please see  http://docs.python.org/py3k/library/argparse.html#module-argparse  and read the first sentence which goes...

"The argparse module makes it easy to write user friendly command line interfaces."

Please fix this to...

"The argparse module makes it easy to write user-friendly command-line interfaces."

Note: "user friendly" --> "user-friendly"
      "command line" --> "command-line"
msg133613 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2011-04-12 23:00
IMO these are a waste of time and add zero value.  Also, the English hyphenation conventions vary depending on who you ask and they vary over time.
msg133623 - (view) Author: Boštjan Mejak (Retro) Date: 2011-04-12 23:34
There are more of this typos in the same chapter. Just a little below the
one of the reported sentence. Check this out...

"Assuming the Python code above is saved into a file called prog.py, it can
be run at the !! command line !! and provides useful help messages:"  --> it
has to be: command-line

But then this...

"When run with the appropriate arguments, it prints either the sum or the
max of the !! command-line !! integers:"  --> here it is correct!

I don't get it. Please be consistent. Thanks.
msg133627 - (view) Author: Benjamin Peterson (benjamin.peterson) * (Python committer) Date: 2011-04-13 00:15
2011/4/12 Boštjan Mejak <report@bugs.python.org>:
>
> Boštjan Mejak <bostjan.mejak@gmail.com> added the comment:
>
> There are more of this typos in the same chapter. Just a little below the
> one of the reported sentence. Check this out...
>
> "Assuming the Python code above is saved into a file called prog.py, it can
> be run at the !! command line !! and provides useful help messages:"  --> it
> has to be: command-line
>
> But then this...
>
> "When run with the appropriate arguments, it prints either the sum or the
> max of the !! command-line !! integers:"  --> here it is correct!
>
> I don't get it. Please be consistent. Thanks.

"A foolish consistency is the hobgoblin of little minds."
msg133647 - (view) Author: Boštjan Mejak (Retro) Date: 2011-04-13 07:51
Georg Brandl, please fix this typos. You would understand. Thank you.
msg133661 - (view) Author: Boštjan Mejak (Retro) Date: 2011-04-13 11:54
Also, please fix the main title of the argparse section...

from
15.4. argparse<http://docs.python.org/dev/library/argparse.html#module-argparse>
—
Parser for command line options, arguments and sub-commands
to
15.4. argparse<http://docs.python.org/dev/library/argparse.html#module-argparse>
—
Parser for command-line options, arguments and sub-commands
Please note the added hyphen (-) for the word command-line. Since this is
actually one word, it needs the hyphen. This is not Python related, but is
orthology related. Please fix all this documentation imprecisions in the
section argparse. Won't take a minute.
msg133663 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2011-04-13 12:38
On Wed, Apr 13, 2011 at 14:54, Boštjan Mejak <report@bugs.python.org> wrote:
>
> Boštjan Mejak <bostjan.mejak@gmail.com> added the comment:
>
> Also, please fix the main title of the argparse section...
>
> from
> 15.4. argparse<http://docs.python.org/dev/library/argparse.html#module-argparse>
> —
> Parser for command line options, arguments and sub-commands
> to
> 15.4. argparse<http://docs.python.org/dev/library/argparse.html#module-argparse>
> —
> Parser for command-line options, arguments and sub-commands
> Please note the added hyphen (-) for the word command-line. Since this is
> actually one word, it needs the hyphen. This is not Python related, but is
> orthology related. Please fix all this documentation imprecisions in the
> section argparse. Won't take a minute.
>

Boštjan, please stop this trolling. You were told by two core-devs
that it won't be fixed. There's no use keeping spamming the mailing
list.

A short googling shows that the jury is still out on the question of
whether command-line is more correct than command line. Some places
use a hyphen, some don't. This really isn't important enough to call
for hunting out hyphen-less spellings throughout the docs.

If you want to contribute to Python, please find issues with substance
to raise. As it is now, you're only harming Python by wasting the time
of core developers.

Eli
msg133692 - (view) Author: Boštjan Mejak (Retro) Date: 2011-04-13 20:48
If you'd look into the English dictionary, you'd find words like
coffee-table and command-line and built-in and user-friendly. The main
bother in this issue is the inconsistency with the wording "command-line".
Somewhere under the argparse section of the docs it is "command line" and
then shortly after it is "command-line". Make up your mind and be consistent
with one wording. I propose to let it be "command-line" as the major
dictionary of English language writes it, with a hyphen that is. Thank you.
msg133762 - (view) Author: Boštjan Mejak (Retro) Date: 2011-04-14 19:11
I did a little mistake with the "coffee-table" thing. It's written as
"coffee table" (no hyphen). But other words listed are written with the
hyphen. Fix those damn things mentioned in the issue.
History
Date User Action Args
2022-04-11 14:57:15adminsetgithub: 56015
2011-04-16 11:47:03Retrosetfiles: - unnamed
2011-04-16 11:47:01Retrosetfiles: - unnamed
2011-04-16 11:46:58Retrosetfiles: - unnamed
2011-04-16 11:46:55Retrosetfiles: - unnamed
2011-04-16 11:46:52Retrosetfiles: - unnamed
2011-04-14 19:11:55Retrosetfiles: + unnamed

messages: + msg133762
2011-04-13 20:48:13Retrosetfiles: + unnamed

messages: + msg133692
2011-04-13 12:38:11eli.benderskysetnosy: + eli.bendersky
messages: + msg133663
2011-04-13 11:54:01Retrosetfiles: + unnamed

messages: + msg133661
2011-04-13 07:51:52Retrosetfiles: + unnamed

messages: + msg133647
2011-04-13 02:04:31rhettingersetstatus: open -> closed
resolution: wont fix
2011-04-13 00:15:43benjamin.petersonsetnosy: + benjamin.peterson
messages: + msg133627
2011-04-12 23:34:17Retrosetfiles: + unnamed

messages: + msg133623
2011-04-12 23:00:37rhettingersetnosy: + rhettinger
messages: + msg133613
2011-04-12 20:26:12Retrosetnosy: + georg.brandl
2011-04-09 08:36:36Retrocreate