Mailman 3 August 2013 - docs

[issue18646] Improve tutorial entry on 'Lambda Forms'.
by Terry J. Reedy Oct. 6, 2013

Oct. 6, 2013

New submission from Terry J. Reedy: [0. On mailing lists, 'lambda expression' is used rather than 'lambda form'. Docs use both. Consistency across docs is a broader issue than this one. So leave title alone for this one.] 1. (first sentence) "By popular demand, a few features commonly found in functional programming languages like Lisp have been added to Python." (in early Python 1!) I think this should just be deleted. See 4. below as a replacement. 2. " With the lambda keyword, small anonymous functions can be created." Change to "Small anonymous functions can be created with the lambda keyword." 3. change "Here’s a function that returns" to "This function returns" 3.5 add a sentence about the different between def and lambda (the name attribute. 4. Add sentences about the purposes of lambda. Add an example that illustrates passing functions. >>> pairs = [(1, 'one'), (2, 'two'), (3, 'three'), (4, 'four')] >>> pairs.sort(key=lambda pair: pair[1]) >>> pairs [(4, 'four'), (1, 'one'), (3, 'three'), (2, 'two')] ---------- assignee: docs@python components: Documentation files: tut-lambda.diff keywords: patch messages: 194296 nosy: docs@python, terry.reedy priority: normal severity: normal stage: patch review status: open title: Improve tutorial entry on 'Lambda Forms'. type: behavior versions: Python 2.7, Python 3.3, Python 3.4 Added file: http://bugs.python.org/file31142/tut-lambda.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18646> _______________________________________

5 6

[issue18790] incorrect text in argparse add_help example
by purplezephyr Oct. 6, 2013

Oct. 6, 2013

New submission from purplezephyr: The last example under add_help in the documentation for the argparse module has incorrect text. It is supposed to demonstrate what happens when prefix_chars doesn't include '-', and add_help is True, but the example has the following: usage: PROG [-h] optional arguments: -h, --help show this help message and exit instead of: usage: PROG [+h] optional arguments: +h, ++help show this help message and exit ---------- assignee: docs@python components: Documentation messages: 195710 nosy: docs@python, purplezephyr priority: normal severity: normal status: open title: incorrect text in argparse add_help example versions: Python 2.7, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18790> _______________________________________

4 5

Typo error 21.10.ossaudiodev Python 2.7 documentation
by Ken Housley Oct. 6, 2013

Oct. 6, 2013

In 21.10.1 Audio Device Objects near the end of the section there is an example of how to use the setparameters() method. The example is said to be equivalent to three separate statements. The last of the three statements is: rate = dsp.rate(channels) I think the statement should be rate = dsp.rate(rate) It is a minor correction, but we would want to fix the small errors as well as the big ones, right? The error appears on the web at http://docs.python.org/2/library/ossaudiodev.html and in the pdf file library.pdf in the python 2.7 documentation. Thanks, Ken Housley

2 1

backslash ending raw string literals.
by Scot Kelly Oct. 6, 2013

Oct. 6, 2013

>From the doc: http://docs.python.org/2/reference/lexical_analysis.html r"\" is not a valid string literal (even a raw string cannot end in an odd number of backslashes). Specifically, a raw string cannot end in a single backslash (since the backslash would escape the following quote character). If it's a raw string, then the backslash will not escape the following quote character. Ergo r"\" should be allowed. Regards, Scot Kelly "Be excellent to each other." PASSPORT CAPITAL One Market Street Steuart Tower, Suite 2200 San Francisco, CA 94105 www.passportcapital.com<http://www.passportcapital.com/> Scot Kelly Tel 415-525-8910 Fax 415-321-4620 skelly(a)passportcapital.com CONFIDENTIALITY: The information transmitted is intended only for the addressee and may contain confidential or privileged material. Any review, retransmission, dissemination or other use of, or taking of any action in reliance upon, this information by anyone other than the intended recipient is prohibited. If you received this message in error, please contact the sender and delete the material from all computers. E-mail transmissions cannot be guaranteed to be secure or error-free and we accept no liability for any errors or omissions. We screen for viruses on a routine basis, however, we make no representation or warranty as to the absence of viruses in this e-mail or any attachments. Please note that for regulatory and compliance reasons we may monitor and read e-mails sent to and from our servers. Passport Capital, LLC and its affiliated investment vehicles are actively engaged in investment management and evaluation activities in global markets and do not wish to be exposed to any nonpublic information regarding any company(s) or security(s) that could be deemed material and restrict their ability to trade securities without their express prior consent.

2 1

[issue16195] Difficult or impossible to figure out how garbage collector and weak references should interact for user-defined extension types
by Jean-Paul Calderone Oct. 5, 2013

Oct. 5, 2013

New submission from Jean-Paul Calderone: There appears to be very little, if any, documentation about how to handle the list at tp_weaklistoffset for types supporting being weak referenced, particularly with respect to garbage collection. Who owns the list? Who owns the objects in the list? Should the list be traversed by the extension type's tp_traverse? Should it ever be INCREF'd or DECREF'd? Does tp_dealloc have any responsibilities with respect to it? >From looking at CPython's own source, it appears that tp_traverse should not touch it (Yhg1s confirmed this on #python). Cython, at least, appears to have come to an alternate conclusion though - it generates tp_traverse functions which visit the list (and provoke gc assertions to fail on Python 2.7 in debug mode). Some documentation about what is correct to do would be excellent, and would make it easier to explain to Cython developers what they're doing wrong (or confirm that they're doing something right, in which case there are some more bugs to file against the CPython stdlib, since they do something different from Cython). ---------- assignee: docs@python components: Documentation messages: 172639 nosy: docs@python, exarkun priority: normal severity: normal status: open title: Difficult or impossible to figure out how garbage collector and weak references should interact for user-defined extension types _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16195> _______________________________________

6 5

[issue17326] Windows build docs still referring to VS 2008 in 3.3
by Christoph Zwerschke Sept. 29, 2013

Sept. 29, 2013

New submission from Christoph Zwerschke: The first paragraph in PCbuild/readme.txt of Python 3.3 still talks about Visual C++ 2008 Express and Visual Studio 2008. It says that VS 2008 is required at the very least (which may be still true, I'm not sure), but then it also says "the official Python releases are built with this [i.e. the 2008] version of VS", while it seems they have been built with VS 2010 in reality (as the title is also indicating). ---------- assignee: docs@python components: Documentation messages: 183259 nosy: cito, docs@python priority: normal severity: normal status: open title: Windows build docs still referring to VS 2008 in 3.3 type: enhancement versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17326> _______________________________________

4 4

[issue17777] Unrecognized string literal escape sequences give SyntaxErrors
by Reynir Reynisson Sept. 24, 2013

Sept. 24, 2013

New submission from Reynir Reynisson: Strings like "\u" trigger a SyntaxError. According to the language reference "all unrecognized escape sequences are left in the string unchanged"[0]. The string "\u" clearly doesn't match any of the escape sequences (in particular \uxxxx). This may be intentional, but it is not clear from the language reference that this is the case. If it is intentional it should probably be stated more explicit in the language reference. I think this may be confusing for new users since the syntax errors may lead them to believe the interpreter will give syntax error for all unrecognized escape sequences. [0]: http://docs.python.org/3/reference/lexical_analysis.html#literals ---------- assignee: docs@python components: Documentation, Unicode messages: 187173 nosy: docs@python, ezio.melotti, reynir priority: normal severity: normal status: open title: Unrecognized string literal escape sequences give SyntaxErrors type: behavior versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17777> _______________________________________

5 5

[issue18206] There is no license.html on www.python.org
by py.user Sept. 14, 2013

Sept. 14, 2013

New submission from py.user: [guest@localhost ~]$ python3 Python 3.3.0 (default, Sep 29 2012, 22:07:38) [GCC 4.7.2 20120921 (Red Hat 4.7.2-2)] on linux Type "help", "copyright", "credits" or "license" for more information. >>> license() See http://www.python.org/3.3/license.html >>> 404 answer from webmaster(a)python.org: Hello, When I use the version of Python distributed by python.org and type "license()" I get the full license text and not the url. It seems like this might be a change made by Red Hat? Either way, the proper place to discuss issues like this is on the Python bug tracker: http://bugs.python.org/ Feel free to report an issue there and the developers can look at it. This email address is actually for reporting problems with the Python.org website! All the best, Michael Foord in Lib/site.py: [guest@localhost cpython]$ sed -n '453,456p' Lib/site.py builtins.license = _Printer( "license", "See http://www.python.org/%.3s/license.html" % sys.version, ["LICENSE.txt", "LICENSE"], [os.path.join(here, os.pardir), here, os.curdir]) [guest@localhost cpython]$ ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 191095 nosy: docs@python, py.user priority: normal severity: normal status: open title: There is no license.html on www.python.org type: behavior versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18206> _______________________________________

8 18

[issue11163] iter() documentation code doesn't work
by Michael Grazebrook Sept. 11, 2013

Sept. 11, 2013

New submission from Michael Grazebrook <michael(a)grazebrook.com>: This code fragment from the documentation of iter() doesn't work as intended. Change "STOP" to "STOP\n". Maybe also check for EOF as it hangs. with open("mydata.txt") as fp: for line in iter(fp.readline, "STOP"): process_line(line) Or maybe this makes a better example because it's clearer wha'ts going on: square_generator = (i * i for i in range(100000)) for n in iter( square_generator.next, 144): print n ---------- assignee: docs@python components: Documentation messages: 128238 nosy: docs@python, mgrazebrook priority: normal severity: normal status: open title: iter() documentation code doesn't work type: behavior versions: Python 2.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11163> _______________________________________

6 10

[issue18815] DOCUMENTATION: "mmap .close()" doesn't close the underlying file
by Jesús Cea Avión Sept. 9, 2013

Sept. 9, 2013

New submission from Jesús Cea Avión: In documentation http://docs.python.org/3.3/library/mmap.html#mmap.close you can read: "Close the file". I could interpret that it is going to close the file vinculated to the MMAP. But it doesn't. It only close the MMAP object (as it should). Please, update doc to clear possible misunderstandings. Thanks. ---------- assignee: docs@python keywords: easy messages: 195939 nosy: docs@python, jcea priority: normal severity: normal status: open title: DOCUMENTATION: "mmap .close()" doesn't close the underlying file _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18815> _______________________________________

4 3