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: tokenize documentation contains typos (argment instead of argument)
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.3, Python 3.4, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: ezio.melotti Nosy List: docs@python, eric.araujo, ezio.melotti, python-dev
Priority: normal Keywords:

Created on 2013-11-16 02:31 by cjwelborn, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (6)
msg203005 - (view) Author: Christopher Welborn (cjwelborn) * Date: 2013-11-16 02:31
Documentation for tokenize contains typos, functions detect_encoding() and tokenize() at least. The lines are:

The tokenize() generator requires one argment, readline,...

It requires one argment, readline,

...where argment is supposed to be 'argument' i'm sure. Things like that bug me in my own code/docs, and since it's been there since 2.7 (Also in 3.3 and 3.4), I figured no one had noticed.
msg203006 - (view) Author: Christopher Welborn (cjwelborn) * Date: 2013-11-16 02:33
Oops, forgot to mention the documentation I am speaking of is the actual doc strings. The actual test is to run:
import tokenize
help(tokenize)

or just:

`python -c "import tokenize;help(tokenize)" | grep "argment"`
msg203874 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2013-11-22 21:00
Thanks for catching this, would you like to make a patch?
http://docs.python.org/devguide gives help to do that.
msg204287 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-11-25 03:16
New changeset 9b170d74a0a2 by Ezio Melotti in branch '2.7':
#19620: Fix typo in docstring (noticed by Christopher Welborn).
http://hg.python.org/cpython/rev/9b170d74a0a2

New changeset 3f99564b712e by Ezio Melotti in branch '3.3':
#19620: Fix typo in docstring (noticed by Christopher Welborn).
http://hg.python.org/cpython/rev/3f99564b712e

New changeset 0d5da548b80a by Ezio Melotti in branch 'default':
#19620: merge with 3.3.
http://hg.python.org/cpython/rev/0d5da548b80a
msg204288 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013-11-25 03:17
Fixed, thanks for the report!
msg209402 - (view) Author: Christopher Welborn (cjwelborn) * Date: 2014-01-27 06:30
I should've made the patch, sorry about that. I got really busy and by the time I came back it had been fixed already. (fast turnaround :)
I'm just glad it got fixed. I'm removing myself from the nosy-list.
History
Date User Action Args
2022-04-11 14:57:53adminsetgithub: 63819
2014-01-27 06:30:47cjwelbornsetnosy: - cjwelborn
2014-01-27 06:30:11cjwelbornsetnosy: ezio.melotti, eric.araujo, docs@python, python-dev, cjwelborn
messages: + msg209402
2013-11-25 03:17:16ezio.melottisetstatus: open -> closed

type: enhancement
assignee: docs@python -> ezio.melotti

nosy: + ezio.melotti
messages: + msg204288
resolution: fixed
stage: resolved
2013-11-25 03:16:28python-devsetnosy: + python-dev
messages: + msg204287
2013-11-22 21:00:30eric.araujosetnosy: + eric.araujo
messages: + msg203874
2013-11-16 02:33:58cjwelbornsetmessages: + msg203006
2013-11-16 02:31:52cjwelborncreate