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: "Documenting Python: Syntax" bug
Type: enhancement Stage:
Components: Documentation Versions: Python 2.5
process
Status: closed Resolution: wont fix
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: benjamin.peterson, georg.brandl, owen
Priority: normal Keywords:

Created on 2008-05-21 01:21 by owen, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (4)
msg67143 - (view) Author: Wallace Owen (owen) Date: 2008-05-21 01:21
The 'documenting Python' document, section 4.1, at this url:
 http://docs.python.org/doc/latex-syntax.html
has an incorrect (but correctly spelled) word in one of it's sentences:

----
Macros which take no parameters but which should not be followed by a
word space do not need special treatment if the following character in
the document source if not a name character (such as punctuation).
----

The phrase "source if not a name" should be "source is not a name".

By the way, in attempting to classify this bug within the parameters
allowed, I observe that there is no correct 'Type' for this bug: none of
the allowed choices seem to apply.  It's not a "crash", "compile error",
"resource usage", "security", "behavior", "performance" or "feature
request".  I figured "feature request" would ring the fewest alarm
bells, so I used that.
msg67144 - (view) Author: Benjamin Peterson (benjamin.peterson) * (Python committer) Date: 2008-05-21 03:07
Thanks for the report. However, since we have moved to a new doc format
(reST), we are not maintaining the 2.5 docs.
msg67145 - (view) Author: Wallace Owen (owen) Date: 2008-05-21 03:34
Thanks for the fast attention.  One question:  How do I access and use
these docs?  I went looking for the instructions on documenting, so when
I contribute, the docs I do are in the right format.  The url I was
reading didn't have a '2.5' in it's path, it was:
 http://docs.python.org/doc/latex-syntax.html

I navigated there by selecting "Browse Current Documentation" at
"http://www.python.org/doc/ which took me directly to the 2.5.2
documentation page.  If the 2.5 stuff isn't current, this link would
appear to be bad.  Should I submit a bug, or have I jammed my head too
far up my ass to be useful? :^)

  // Wally

On Wed, 2008-05-21 at 03:07 +0000, Benjamin Peterson wrote:
> Benjamin Peterson <musiccomposition@gmail.com> added the comment:
> 
> Thanks for the report. However, since we have moved to a new doc format
> (reST), we are not maintaining the 2.5 docs.
> 
> ----------
> nosy: +benjamin.peterson
> resolution:  -> wont fix
> status: open -> closed
> versions: +Python 2.5 -Python 3.0
> 
> __________________________________
> Tracker <report@bugs.python.org>
> <http://bugs.python.org/issue2933>
> __________________________________
msg67150 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2008-05-21 07:46
The 2.5.2 stuff *is* the current docs for 2.5. However, the docs that
are actively maintained are the docs for 2.6 and 3.0, the former of
which can be found at http://www.python.org/doc/dev/.

With the release of 2.6, these will become the most "current" docs.
History
Date User Action Args
2022-04-11 14:56:34adminsetgithub: 47182
2008-05-21 07:47:01georg.brandlsetmessages: + msg67150
2008-05-21 03:34:19owensetmessages: + msg67145
2008-05-21 03:07:10benjamin.petersonsetstatus: open -> closed
nosy: + benjamin.peterson
resolution: wont fix
messages: + msg67144
versions: + Python 2.5, - Python 3.0
2008-05-21 01:21:15owencreate