Mailman 3 October 2011 - docs

Mistake in the Python 3.2.2rc1 "help(set)"
by Joao Carneiro Oct. 12, 2011

Oct. 12, 2011

Hello, I would like to report that I found a mistake in the document of "help(set)". In the document all the __i*__ methods are described exactly like the same methods without i before the name. Copied from the document: __ixor__(...) x.__ixor__(y) <==> x^y __xor__(...) x.__xor__(y) <==> x^y I suppose that the __ixor__ would mean x^=y and not x^y like the __xor__ method right? This problem also occurs for: __iand__ __ior__ __isub__ Best regards, Joao Carneiro

2 1

[issue12602] Missing cross-references in Doc/using
by Éric Araujo Oct. 12, 2011

Oct. 12, 2011

Éric Araujo <merwok(a)netwok.org> added the comment: > I suggest that it do so in this instance also, using *script* (in > bold-faced italic) as the entry title. What do you think about :file:`{script}`? file+{} is what Sphinx uses for filenames with replaceable parts, which map to the HTML var element, which the stylesheets display as italics. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12602> _______________________________________

1 0

I found a question in the documentation.
by Ray Wang Oct. 12, 2011

Oct. 12, 2011

In the chapter of "3.1.2 String", the example: >>> '"Isn\'t," she said.' '"Isn\'t," she said.' Should the printed result be '"Isn't," she said.' ?

2 1

Hard Copy Documentation
by John Rowland Oct. 12, 2011

Oct. 12, 2011

Hi Guys, >From where can I obtain hard copy documentation - preferably in the form of proper books - on all aspects of Python? I have already bought the book Natural Language Processing with Python, and whilst this is useful, it is not a reference manual. What I need is a book with all the commands, statements, expressions etc. listed (ideally alphabetically) along with their syntax. I'm the sort of guy that starting from and given the ">>>" prompt, want to know what my options are in response to this. I also need more explanation on all sorts of things. As an example, "Import". What does this actually do? What does import really mean? Where is the imported item stored? What happens if I import when I've already imported? That sort of thing. Sorry if I'm an awkward so_and_so but this is just how my mind works. Hope to hear back from you soon. Kind regards, John Rowland York, United Kingdom

2 1

[issue13145] Documentation of PyNumber_ToBase() wrong
by Sven Marnach Oct. 11, 2011

Oct. 11, 2011

New submission from Sven Marnach <sven(a)marnach.net>: The documentation of PyNumber_ToBase() [1] states When base is not 2, 8, 10, or 16, the format is 'x#num' where x is the base. In reality, the function does not accept any bases different from 2, 8, 10, or 16, as can be seen in the source code of _PyLong_Form() [2], which is called from PyNumber_ToBase() to do the actual conversion. The patch fixes the documentation. [1]: http://docs.python.org/c-api/number.html#PyNumber_ToBase [2]: http://hg.python.org/cpython/file/f924e0f62bcb/Objects/longobject.c#l1663 ---------- assignee: docs@python components: Documentation files: pynumber-tobase-doc.patch keywords: patch messages: 145297 nosy: docs@python, smarnach priority: normal severity: normal status: open title: Documentation of PyNumber_ToBase() wrong Added file: http://bugs.python.org/file23367/pynumber-tobase-doc.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13145> _______________________________________

3 4

windows help file (.chm) for Python 2.7
by xDog Walker Oct. 11, 2011

Oct. 11, 2011

The file I downloaded yesterday (2011 October 10) is messed up: The index section is abnormal; it appears to be displaying the "target" rather than the "key". Anyway, that function of the chm file is worthless here. (I have many other chm files that do not exhibit this behavior and no others that do.) -- I have seen the future and I am not in it.

1 0

[issue10976] json.loads() throws TypeError on bytes object
by Barry A. Warsaw Oct. 11, 2011

Oct. 11, 2011

Barry A. Warsaw <barry(a)python.org> added the comment: I'll just mention that the elimination of bytes handling is a bit unfortunate, since this idiom which works in Python 2 no longer works: fp = urlopen(url) json_data = json.load(fp) /me sad ---------- nosy: +barry _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10976> _______________________________________

2 1

[issue12602] Missing cross-references in Doc/using
by Terry J. Reedy Oct. 11, 2011

Oct. 11, 2011

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: That was the page I said I would look at. My suggest is that one or more of the directory entries could have either a bit more information about the directory or a "More info" link to a separate page. As a remember, files for modules were named after the module and easy to find. Those could be disposed of in one sentence. But files for the manuals were less so and could use more info. My memory of Objects is that most files were obvious but, again, a few were/are not. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12602> _______________________________________

1 0

[issue12602] Missing cross-references in Doc/using
by Nick Coghlan Oct. 11, 2011

Oct. 11, 2011

Nick Coghlan <ncoghlan(a)gmail.com> added the comment: Don't feel bad about not recognising the context - this stuff wasn't documented at all for a long time, and it wasn't until Georg pointed me to the usage docs that I realised adding it there would be the right place. I should have remembered that and been less cryptic when creating this issue. It may suggest a meta-issue though - perhaps 'Documenting Python' should grow a devguide-style description of the Docs layout in source control, with a pointer from the devguide's directory layout description [1]? [1] http://docs.python.org/devguide/setup.html#directory-structure ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12602> _______________________________________

1 0

[issue12602] Missing cross-references in Doc/using
by Terry J. Reedy Oct. 10, 2011

Oct. 10, 2011

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: I was not necessary suggesting that the filename actually be changed, just that the mapping between docs and filenames is not always obvious. I will somedays look at the dev docs doc page and see if I have any further suggestions to help. Add 'in the Python doc context' after 'not familiar with it'. I *am* familiar with <text> in monofont ascii text and use it, for instance, in newsgroup posts. But unlike man pages, the Python docs are not so restricted and, except in this instance, use italics for parameter names. I suggest that it do so in this instance also, using *script* (in bold-faced italic) as the entry title. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12602> _______________________________________

1 0