Mailman 3 June 2010 - docs

Python documentation : some points requiring attention
by Jacques June 7, 2010

June 7, 2010

Hi Georg, Here is a second list of issues found while navigating through the rich Python 3.1.1 official documentation. Hope this would be useful. With regards. Jacques DUCASSE FRANCE NB : in your reply to my previous email, you say you couldn't find the "default ascii encoding" in the HowTo. Here I join a screenshot of this. Georg Brandl a écrit : > -----BEGIN PGP SIGNED MESSAGE----- > Hash: SHA1 > > Am 21.03.2010 00:02, schrieb Jacques: >> Hello, >> >> … [View More]

1 0

[issue8910] Write a text file explaining why Lib/test/data exists
by Éric Araujo June 7, 2010

June 7, 2010

Éric Araujo <merwok(a)netwok.org> added the comment: Attaching a proposal. I think the component is a grey area between tests and documentation, so I’d be for including this file in all four branches. ---------- keywords: +needs review, patch nosy: +docs@python, merwok Added file: http://bugs.python.org/file17581/README _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8910> _______________________________________

1 0

[issue8875] XML-RPC improvement is described twice.
by INADA Naoki June 7, 2010

June 7, 2010

New submission from INADA Naoki <songofacandy(a)gmail.com>: http://docs.python.org/dev/whatsnew/2.7.html#new-and-improved-modules "The XML-RPC client and server, provided by..." appears twice. ---------- assignee: docs@python components: Documentation messages: 106875 nosy: docs@python, naoki priority: normal severity: normal status: open title: XML-RPC improvement is described twice. versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.… [View More]

3 2

[issue8519] doc: termios and ioctl reference links
by Brian Curtin June 7, 2010

June 7, 2010

Changes by Brian Curtin <curtin(a)acm.org>: ---------- title: [patch] doc: termios and ioctl reference links -> doc: termios and ioctl reference links _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8519> _______________________________________

1 0

[issue8909] mention bitmap size for bdist_wininst
by Tarek Ziadé June 6, 2010

June 6, 2010

New submission from Tarek Ziadé <ziade.tarek(a)gmail.com>: done in r81788, r81789, r81790, r81791 thanks! ---------- resolution: -> fixed stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8909> _______________________________________

1 0

Sphinx indexing
by anatoly techtonik June 6, 2010

June 6, 2010

I've stumbled upon definition of `open` function in http://docs.python.org/genindex-O.html and I wonder - why none of the following entries leads to definition of `open`? open built-in function, [1] I see that linked paragraphs have explicit `builtin: open` markup, but can't find their intended usage in Sphinx documentation. To me the index should look like: open (built-in function) Files Reading and Writing Files or open (built-in function) definition [1] Files [2] … [View More]

1 0

[issue8890] Modules have dangerous examples in documentation
by Henri Salo June 5, 2010

June 5, 2010

Henri Salo <henri(a)nerv.fi> added the comment: No it does not. http://www.owasp.org/index.php/Insecure_Temporary_File ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8890> _______________________________________

1 0

[issue8909] mention bitmap size for bdist_wininst
by anatoly techtonik June 5, 2010

June 5, 2010

Changes by anatoly techtonik <techtonik(a)gmail.com>: ---------- nosy: +docs@python _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8909> _______________________________________

1 0

[issue7229] Manual entry for time.daylight can be misleading
by anatoly techtonik June 5, 2010

June 5, 2010

anatoly techtonik <techtonik(a)gmail.com> added the comment: It is too hard to track this issue without quotes from manual. Let's bring context into discussion: http://docs.python.org/library/time.html#time.altzone UTC offset of the local DST timezone if one is defined. Only use this if daylight is nonzero. http://docs.python.org/library/time.html#time.daylight Nonzero if a DST timezone is defined. http://docs.python.org/library/time.html#time.timezone UTC offset of the local (… [View More]

2 2

[issue7229] Manual entry for time.daylight can be misleading
by Alexander Belopolsky June 5, 2010

June 5, 2010

Alexander Belopolsky <belopolsky(a)users.sourceforge.net> added the comment: It may be a bit off-topic for this issue, but I don't like that the python manual uses UTC as if it was a geographical location. UTC is a time scale. You cannot be to the east or to the west of UTC just as you cannot be to the north of the Gregorian calendar. Even if we replace UTC with Prime or Greenwich Meridian, the manual would still be incorrect because some regions in the western hemisphere use positive … [View More]

1 0