Mailman 3 January 2011 - docs

[issue10225] Fix doctest runable examples in python manual
by Terry J. Reedy Jan. 10, 2011

Jan. 10, 2011

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: As I understand this, your patch would fix numerous errors in the docs, but has not been applied. It would be nice to get the fixes into 3.2. What sort of feedback do you want? Proofreading of text? Recheck of doctest? Does sphinx suppress doctest comments like #doctest: +IGNORE_EXCEPTION_DETAIL ? doctest.testfile("C:/programs/PyDev/py32/Doc/howto/sorting.rst", module_relative = False) fails 23 of 37 attempts, so improvement … [View More]

2 1

[issue10858] Make source code links less proeminent
by Antoine Pitrou Jan. 10, 2011

Jan. 10, 2011

New submission from Antoine Pitrou <pitrou(a)free.fr>: Reading library source code will only be enlightening to expert users, since most modules are not academic but real-world implementations, with all the complications it entails. Therefore, putting a link at the top of module sections is only confusing for most people. I would like to shift these links to the bottom of doc pages, where we already have "see also" links to RFCs and the like. ---------- assignee: docs@python components: … [View More]

6 10

[issue10873] String formatting example invalid
by Ashwin Purohit Jan. 9, 2011

Jan. 9, 2011

New submission from Ashwin Purohit <purohit(a)gmail.com>: Your example on page http://docs.python.org/tutorial/inputoutput.html is outdated and won't work in Python 2.7: Basic usage of the str.format() method looks like this: >>> print 'We are the {} who say "{}!"'.format('knights', 'Ni') We are the knights who say "Ni!" Now, all brackets have to have a numeric or keyword argument. ---------- assignee: docs@python components: Documentation messages: 125838 nosy: doagie, … [View More]

4 4

Docs in epub or single-html (without the left menu) format
by Santiago Romero Jan. 9, 2011

Jan. 9, 2011

Hi all. First of all, sorry for my poor english. I've recently purchased a nice 9 inches e-ink ebook reader and I wanted to read all python 2.7 documentation by using it, but I've been unable to found python.org's documents in .epub format. PDF is not usable in ebook readers because is intended for printing and the "blank" page margins make the documents almost unreadable. On other websites/projects, when I can't find a document in epub format, I usually download and use the "single html" … [View More]

2 1

A probable bug in The Python Tutorial
by Youcheng Lin Jan. 9, 2011

Jan. 9, 2011

Hi, In the section 3.2. First Steps Towards Programming This example introduces several new features. - The first line contains a *multiple assignment*: the variables a and b simultaneously get the new values 0 and 1. On the last line this is used again, demonstrating that the expressions on the right-hand side are all evaluated first before any of the assignments take place. The right-hand side expressions are evaluated from the* left to the right.* * * I think … [View More]

2 1

[issue10871] argparse example use "file" instead of "open"
by Baptiste Lepilleur Jan. 9, 2011

Jan. 9, 2011

New submission from Baptiste Lepilleur <blep(a)users.sourceforge.net>: In section "14.4.3.6. type" of the argparse module, the following code sample is given: >>> parser = argparse.ArgumentParser() >>> parser.add_argument('foo', type=int) >>> parser.add_argument('bar', type=file) >>> parser.parse_args('2 temp.txt'.split()) Namespace(bar=<open file 'temp.txt', mode 'r' at 0x...>, foo=2) The built-in "file" used for argument 'bar' no longer … [View More]

2 1

[issue10870] Last line of argparse code samples can not be read on Windows
by Baptiste Lepilleur Jan. 9, 2011

Jan. 9, 2011

New submission from Baptiste Lepilleur <blep(a)users.sourceforge.net>: When the code samples from the CHM documentation are displayed, if the lines are too long, a scroll bar is added at the bottom which prevents reading the last line of the code sample. Usually this can be worked-around by making the windows larger, but some examples in the documentation of the argparse are so wide that even in full screen, the window is not wide enough. I attached a screen capture to illustrate the … [View More]

2 1

[issue10533] Need example of using __missing__
by Éric Araujo Jan. 9, 2011

Jan. 9, 2011

Éric Araujo <merwok(a)netwok.org> added the comment: Great, thanks. We’ll see later if more cross-links are needed. ---------- stage: needs patch -> committed/rejected _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10533> _______________________________________

1 0

[issue10357] ** and "mapping" are poorly defined in python docs
by Fergal Daly Jan. 8, 2011

Jan. 8, 2011

New submission from Fergal Daly <fergald(a)gmail.com>: According to the index, the only place that mentions ** in argument lists is http://docs.python.org/tutorial/controlflow.html#index-1099 and gives no indication of what an object must support to allow **. When you attempt to ** an object the real attribute exception is suppressed and you get a message "argument after ** must be a mapping" "mapping" is quite loosely defined. There are 3 definitions, the glossary entry seems the … [View More]

4 6

[issue10863] zlib.compress() fails with string
by Jose-Luis Fernandez-Barros Jan. 8, 2011

Jan. 8, 2011

New submission from Jose-Luis Fernandez-Barros <jlfbarros(a)gmail.com>: On "The Python Tutorial", section 10.9. Data Compression http://docs.python.org/py3k/tutorial/stdlib.html#data-compression >>> import zlib >>> s = 'witch which has which witches wrist watch' ... >>> t = zlib.compress(s) Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: must be bytes or buffer, not str Possible solution (sorry, newbie) are: &… [View More]

2 4