"Documenting Python: Syntax" bug

[owen]

BPO	2933
Nosy	@birkenfeld, @benjaminp

^{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-05-21.03:07:10.386>
created_at = <Date 2008-05-21.01:21:14.282>
labels = ['type-feature', 'docs']
title = '"Documenting Python: Syntax" bug'
updated_at = <Date 2008-05-21.07:47:01.193>
user = 'https://bugs.python.org/owen'

bugs.python.org fields:

activity = <Date 2008-05-21.07:47:01.193>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2008-05-21.03:07:10.386>
closer = 'benjamin.peterson'
components = ['Documentation']
creation = <Date 2008-05-21.01:21:14.282>
creator = 'owen'
dependencies = []
files = []
hgrepos = []
issue_num = 2933
keywords = []
message_count = 4.0
messages = ['67143', '67144', '67145', '67150']
nosy_count = 3.0
nosy_names = ['georg.brandl', 'benjamin.peterson', 'owen']
pr_nums = []
priority = 'normal'
resolution = 'wont fix'
stage = None
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue2933'
versions = ['Python 2.5']

[owen]

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.

[benjaminp]

Thanks for the report. However, since we have moved to a new doc format
(reST), we are not maintaining the 2.5 docs.

[owen]

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\>

---

[birkenfeld]

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.