Mailman 3 August 2014 - docs

[issue22196] namedtuple documentation could/should mention the new Enum type
by Lele Gaifax Oct. 28, 2014

Oct. 28, 2014

New submission from Lele Gaifax: The documentation of namedtuple, near the end, talks about implementing enumerated constants and says “Enumerated constants can be implemented with named tuples, but it is simpler and more efficient to use a simple class declaration“. Maybe it should mention the recently added Enum type instead/too. ---------- assignee: docs@python components: Documentation messages: 225303 nosy: docs@python, lelit priority: normal severity: normal status: open title: namedtuple documentation could/should mention the new Enum type _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22196> _______________________________________

5 5

[issue22237] sorted() docs should state that the sort is stable
by Wilfred Hughes Oct. 28, 2014

Oct. 28, 2014

New submission from Wilfred Hughes: According to https://wiki.python.org/moin/HowTo/Sorting/#Sort_Stability_and_Complex_Sorts and Alex Martelli: http://stackoverflow.com/q/1915376/509706, Python's sorted() is stable. It would be great to update the docs for sorted() to state this. ---------- assignee: docs@python components: Documentation messages: 225574 nosy: Wilfred.Hughes, docs@python priority: normal severity: normal status: open title: sorted() docs should state that the sort is stable type: enhancement versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22237> _______________________________________

8 14

[issue13918] locale.atof documentation is missing func argument
by Cédric Krier Oct. 23, 2014

Oct. 23, 2014

New submission from Cédric Krier <cedric.krier(a)b2ck.com>: atof has a func argument used to instantiate the result but it is missing in the documentation. ---------- assignee: docs@python components: Documentation messages: 152430 nosy: ced, docs@python priority: normal severity: normal status: open title: locale.atof documentation is missing func argument type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13918> _______________________________________

8 26

[issue13769] json.dump(ensure_ascii=False) return str instead of unicode
by Марк Коренберг Oct. 23, 2014

Oct. 23, 2014

New submission from Марк Коренберг <socketpair(a)gmail.com>: $ ipython In [1]: type(json.dumps({'a':'b'}, ensure_ascii=False)) Out[1]: <type 'str'> In [2]: type(json.dumps({'a':u'b'}, ensure_ascii=False)) Out[2]: <type 'unicode'> ----------------------- Documentation: If ensure_ascii is False, then the return value will be a unicode instance. -------------------------------- Not applicable to python3 ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 151066 nosy: docs@python, mmarkk priority: normal severity: normal status: open title: json.dump(ensure_ascii=False) return str instead of unicode type: behavior versions: Python 2.6, Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13769> _______________________________________

7 13

[issue16863] Argparse tutorial outdated
by Charlie Dimino Oct. 22, 2014

Oct. 22, 2014

New submission from Charlie Dimino: http://docs.python.org/2/howto/argparse.html Error message in the first example is outdated, may indicate further out of date information on page. Example: The tutorial says: prog.py: error: the following arguments are required: echo When the actual error received is: prog.py: error: too few arguments ---------- assignee: docs@python components: Documentation messages: 179041 nosy: Charlie.Dimino, docs@python priority: normal severity: normal status: open title: Argparse tutorial outdated versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16863> _______________________________________

8 13

[issue15204] Deprecate the 'U' open mode
by Serhiy Storchaka Oct. 19, 2014

Oct. 19, 2014

New submission from Serhiy Storchaka <storchaka(a)gmail.com>: Since Python 2.3 many open functions supports "Universal line mode" (PEP 278). Since 3.0 (and 2.6) PEP 3116 suggests better alternative -- io.TextWrapper. Now support for the 'U' mode in the different open functions is heterogeneous. Some functions simply ignore the 'U' mode (but accept it), others perceive it as a synonym for text-mode, others just pass it on lower lever, other attempt to implement it, but the implementation is obtained imperfect and contradictory (as in ZipExtFile). The documentation for built-in open does not advise the use of the 'U' mode. The 'U' mode support cumbersome. I propose to deprecate the 'U' mode. If someone wanted to work with the universal line support, he'll surely need to work with encodings too, and io.TextWrapper provides is better choise. The deprecation plan for the 'U' mode of open functions might be as follow: 3.3. Deprecating the 'U' mode in docs for all opens (building open, io.open, codecs.open, gzip.open, ZipFile.open, etc). Add suggestion about io.TextWrapper. 3.4. Raise a warning on use of the 'U' mode. 3.5. Raise an exception on use of the 'U' mode. 3.6 (or 4.0?). Remove the 'U' mode processing code. As the first stage involves only the changes to the documentation, I hope deprecation can starts in 3.3. ---------- assignee: docs@python components: Documentation, IO, Library (Lib) messages: 164142 nosy: docs@python, storchaka priority: normal severity: normal status: open title: Deprecate the 'U' open mode type: behavior versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15204> _______________________________________

14 34

[issue22186] Typos in .py files
by Févry Thibault Oct. 19, 2014

Oct. 19, 2014

New submission from Févry Thibault: The patch removes several typos found in .py files. ---------- assignee: docs@python components: Documentation files: spelling.diff keywords: patch messages: 225232 nosy: docs@python, iwontbecreative priority: normal severity: normal status: open title: Typos in .py files type: enhancement Added file: http://bugs.python.org/file36358/spelling.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22186> _______________________________________

5 6

[issue21189] Broken link to patch
by LtWorf Oct. 14, 2014

Oct. 14, 2014

New submission from LtWorf: This page https://mail.python.org/mailman/listinfo/patches suggests to go here: http://www.python.org/patches/ to know how to send patches. However that page doesn't exist. ---------- assignee: docs@python components: Documentation messages: 215819 nosy: docs@python, tiposchi priority: normal severity: normal status: open title: Broken link to patch type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21189> _______________________________________

3 3

[issue21227] Decimal class error messages for integer division aren't good
by leewz Oct. 14, 2014

Oct. 14, 2014

New submission from leewz: Python's `decimal.Decimal` doesn't seem to like taking modulo or intdiv of large Decimals by integers (where "large" depends on how many digits are internally stored). >>> from decimal import * >>> getcontext().prec 28 >>> Decimal(10**29)%1 Traceback (most recent call last): File "<stdin>", line 1, in <module> decimal.InvalidOperation: [<class 'decimal.DivisionImpossible'>] >>> getcontext().prec=50 >>> Decimal(10**29)%1 Decimal('0') Same for `Decimal(10**29)//1` This is a logical problem: "Alice has a 100-digit number which begins with 1543256. What is the last digit?" But I found the error hard to understand. Searching for "DivisionImpossible" didn't turn up anything immediate (it wasn't added to the official docs?). I was most of the way through writing out a question to StackOverflow when it clicked. (Also, why is it an InvalidOperation that holds an exception as a message? Never saw that before.) Suggestions: - Improve docs with further examples. The examples of InvalidOperation are logical MATH errors (e.g. division by 0), not logical PROGRAMMING errors. - Uh, maybe the error message could be changed to something like, "The answer you seek lies beyond the mantissa." Or more sanely, "Not enough precision to compute the answer." Or something else that hints to me to look into precision. ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 216253 nosy: docs@python, leewz priority: normal severity: normal status: open title: Decimal class error messages for integer division aren't good type: enhancement versions: Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21227> _______________________________________

4 14

[issue12965] longobject: documentation improvements
by Stefan Krah Oct. 14, 2014

Oct. 14, 2014

New submission from Stefan Krah <stefan-usenet(a)bytereef.org>: I think the integer objects documentation could be clearer on a couple of points: - Despite being listed under "Concrete Objects Layer", some functions implicitly accept anything with an __int__() method. Currently only the PyLong_AsLong() documentation states this explicitly. The patch clearly distinguishes between functions that duck type and functions that don't. - The patch replaces "is greater than *_MAX" instances with "out of bounds" to include the other error condition "is less than *_MIN". Additionally, the patch fixes comments in longobject.c that don't state the duck typing behavior. ---------- assignee: docs@python components: Documentation files: longobject-doc.diff keywords: patch messages: 143922 nosy: docs@python, mark.dickinson, skrah priority: normal severity: normal stage: patch review status: open title: longobject: documentation improvements type: feature request versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3 Added file: http://bugs.python.org/file23133/longobject-doc.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12965> _______________________________________

3 11