Mailman 3 September 2010 - docs

[issue9117] class syntax not fully documented in reference manual
by Mark Dickinson Oct. 17, 2010

Oct. 17, 2010

New submission from Mark Dickinson <dickinsm(a)gmail.com>: Looking at: http://docs.python.org/dev/py3k/reference/compound_stmts.html#class-definit… I see: classdef ::= [decorators] "class" classname [inheritance] ":" suite inheritance ::= "(" [expression_list] ")" classname ::= identifier this seems to be missing the keyword arguments that are now possible in a classdef (e.g. for specifying a metaclass). I believe that *args and **kwargs are now also syntactically accepted in a class definition. ---------- assignee: docs@python components: Documentation messages: 108917 nosy: docs@python, mark.dickinson priority: normal severity: normal status: open title: class syntax not fully documented in reference manual versions: Python 3.1, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9117> _______________________________________

3 9

[issue9112] argparse missing documentation for error() method
by Mark Summerfield Oct. 17, 2010

Oct. 17, 2010

New submission from Mark Summerfield <mark(a)qtrac.eu>: The argparse module's ArgumentParser class has an error() method that appears to have the same behavior as the optparse error() method, but this method is not mentioned in the documentation. ---------- assignee: docs@python components: Documentation messages: 108896 nosy: docs@python, mark priority: normal severity: normal status: open title: argparse missing documentation for error() method versions: Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9112> _______________________________________

4 3

[issue9105] pickle security note should be more prominent
by anatoly techtonik Oct. 17, 2010

Oct. 17, 2010

New submission from anatoly techtonik <techtonik(a)gmail.com>: Pickle warning about insecurity is located only at the second page near the bottom of "Relationship to other Python modules" chapter. For me the proper place for it is the first page of documentation. ---------- assignee: docs@python components: Documentation messages: 108847 nosy: docs@python, techtonik priority: normal severity: normal status: open title: pickle security note should be more prominent versions: Python 2.6, Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9105> _______________________________________

5 9

parser library documentation references non-existent example.py
by Bill Zingler Oct. 17, 2010

Oct. 17, 2010

Reference: http://docs.python.org/library/parser.html#information-discovery <http://docs.python.org/library/parser.html>This page says to "See file example.py" several times, but doesn't provide a link to the file or the complete text of the file. It would be really helpful to have example.py. Thanks, Bill -- Bill Zingler Zingler & Associates, Inc. (443) 822-4857

2 1

[issue9086] Wrong linking terminology in windows FAQ
by John Miller Oct. 17, 2010

Oct. 17, 2010

New submission from John Miller <gyuval(a)gmail.com>: The 'How can I embed Python' section in the 'Python on Windows FAQ' (http://docs.python.org/faq/windows.html) uses wrong terms: What the FAQ calls static linking and dynamic linking are actally two forms of dynamic linking - load-time dynamic linking and run-time dynamic linking, respectively. Static linking means something else entirely - linking with a library that itself contains the implementation, i.e. there will be no usage of the DLL at all. Since the FAQ states that pythonNN.lib is just an import lib, static linking isn't really an option with this library. Also the FAQ states that 'The drawback to dynamic linking is that your app won’t run if pythonNN.dll does not exist on your system'. This is misleading for two reasons: - If the application uses the DLL, it won't run as expected if the DLL doesn't exist, regardless of how it loads the DLL. - Of the two linking options, load-time dynamic linking (what the FAQ refers to as static linking) is actually the one that handles the missing DLL more badly: The app will crash upon loading. If run-time dynamic linking is used, loading of the DLL happens in the application code, and it can handle it however it chooses to - it can inform the user, disable the feature that needs the DLL, etc. ---------- assignee: docs@python components: Documentation messages: 108700 nosy: docs@python, john.miller priority: normal severity: normal status: open title: Wrong linking terminology in windows FAQ versions: Python 2.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9086> _______________________________________

5 4

audioop module documentation bug
by Kalle Karjalainen Oct. 17, 2010

Oct. 17, 2010

Hello, I found a bug in http://docs.python.org/library/audioop.html In the example method, def mul_stereo(sample, width, lfactor, rfactor), the result of its first two lines: lsample = audioop.tomono(sample, width, 1, 0) rsample = audioop.tomono(sample, width, 0, 1) ... is discarded by the following two lines: lsample = audioop.mul(sample, width, lfactor) rsample = audioop.mul(sample, width, rfactor) ... resulting in a sample twice as long being returned as is intended, i.e. "slowing down” of the audio. The fix for the third and fourth lines is: lsample = audioop.mul(lsample, width, lfactor) rsample = audioop.mul(rsample, width, rfactor) Best, Kalle Karjalainen

2 1

[issue8968] token type constants are not documented
by Ilya Sandler Oct. 17, 2010

Oct. 17, 2010

New submission from Ilya Sandler <ilya.sandler(a)gmail.com>: the token module defines constants for token types e.g NAME = 1 NUMBER = 2 STRING = 3 NEWLINE = 4 etc. These constants are very useful for any code which needs to tokenize python source, yet they are not listed in the documentation. Is this a documentation bug? ---------- assignee: docs@python components: Documentation messages: 107509 nosy: docs@python, isandler priority: normal severity: normal status: open title: token type constants are not documented versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8968> _______________________________________

3 5

hmac.digest() return value
by Perseids Oct. 17, 2010

Oct. 17, 2010

Hi, I am new to Python 3, but I believe I have found a little error in the documentation. The return value of hmac.digest() is a bytes object, and not a string. See http://docs.python.org/py3k/library/hmac.html . Regards Perseids

2 1

[issue8855] Shelve documentation lacks security warning
by Longpoke Oct. 17, 2010

Oct. 17, 2010

New submission from Longpoke <longpoke(a)gmail.com>: Loading a shelve can cause arbitrary code to be executed [1] and other black magic (because it's backed by Pickle). Shouldn't there be a big fat warning at the top of the shelve documentation page? Unless you're like me and assume anything to do with serialization in any language is insecure until proved otherwise, you aren't going to intuitively think there is anything wrong with "unshelving" untrusted data (unless you already know that Pickle is insecure). 1. http://nadiana.com/python-pickle-insecure#comment-261 ---------- assignee: docs@python components: Documentation messages: 106746 nosy: docs@python, q94IjzUfnNoyv4c75mMw priority: normal severity: normal status: open title: Shelve documentation lacks security warning _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8855> _______________________________________

3 3

[issue8811] fixing sqlite3 docs for py3k
by Shashwat Anand Oct. 17, 2010

Oct. 17, 2010

New submission from Shashwat Anand <anand.shashwat(a)gmail.com>: The docs of sqlite3 for python 3.0 and 3.1 seems to be written for python 2.6 and hence wrong at many places. like, >>> for member in r: print member However the docs for sqlite3 in py3k trunk seems fine. The sqlite3 doc in py3k trunk should be used in these places. http://docs.python.org/release/3.0.1/library/sqlite3.html http://docs.python.org/release/3.1/library/sqlite3.html ---------- assignee: docs@python components: Documentation files: sqlite.rst.patch keywords: patch messages: 106382 nosy: docs@python, georg.brandl, ghaering, l0nwlf priority: normal severity: normal status: open title: fixing sqlite3 docs for py3k versions: Python 3.1, Python 3.2 Added file: http://bugs.python.org/file17451/sqlite.rst.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8811> _______________________________________

3 6