Mailman 3 March 2017 - docs

[issue29756] Improve documentation for list methods that compare items by equality
by Steven D'Aprano 08 Mar '17

08 Mar '17

Steven D'Aprano added the comment: To be clear, I'm referring to the docs in the tutorial: https://docs.python.org/3.7/tutorial/datastructures.html and the docstrings as well as the library reference: https://docs.python.org/3.7/library/stdtypes.html#sequence-types-list-tuple… The library reference already notes that `remove` uses equality, but the others do not. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29756> _______________________________________

1 0

[issue29756] Improve documentation for list methods that compare items by equality
by Steven D'Aprano 08 Mar '17

08 Mar '17

Steven D'Aprano added the comment: Further to Barry's explanation, you see the same result with any values which compare equal: py> from decimal import Decimal as D py> [1, 1.0, D(1), True, 1+0j].count(D(1)) 5 This is standard behaviour for methods `count`, `remove`, and `index`, but it isn't explained well in the documentation. E.g. `remove` says "Remove the first item from the list whose value is x` which could be read as meaning that the test is done by identity. All three methods need to clarify that ordinary == equality is used. I'm going to re-open the task as a documentation issue. ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python, steven.daprano resolution: not a bug -> stage: resolved -> status: closed -> open title: List count() counts True as 1 -> Improve documentation for list methods that compare items by equality type: -> enhancement versions: -Python 2.7, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29756> _______________________________________

1 0

power BUG
by Faraz Nateghi Rad 08 Mar '17

08 Mar '17

hi 1000**(1/3) most return 10 but return 9.99999998 tanx for your attention

2 1

[issue29751] PyLong_FromString fails on decimals with leading zero and base=0
by Mark Dickinson 08 Mar '17

08 Mar '17

Mark Dickinson added the comment: Yes, PyLong_FromString is directly used by the implementation of int, and is also used in parsing of numeric integer literals in source: https://github.com/python/cpython/blob/cb41b2766de646435743b6af7dd152751b54… So I agree that this is a documentation bug. There's also no mention of the support for underscores in the documentation. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29751> _______________________________________

1 0

Report bug of fixes.py
by Supakit Kriangkhajorn 08 Mar '17

08 Mar '17

Dear, support I met bug in fixes.py file. Bug detail : File "C:\Python36\lib\site-packages\sklearn\utils\fixes.py", line 406, in <module> if np_version < (1, 12, 0): TypeError: '<' not supported between instances of 'str' and 'int' Solution : Edit line 406 from if np_version < (1, 12, 0) to if np_version < (1, 12) May be, It occur only my laptop, please test it and if you not understand please reply me. Thank you.

1 0

Questions about API documentation
by Ahmet-Serdar Karakaya 08 Mar '17

08 Mar '17

Hello, I am trying to understand how to write good API documentation. I have read “7. Documenting Python” in the python developers guide [1] and skimmed the Doc-SIG email archives, but I still have some questions and I would appreciate your help. (Whenever I refer to me in the following questions, I mean documentation authors in general) 1) How much should I (or a documentation author in general) go into detail? I don’t want to bore experienced users, but I don’t want to scare beginners away either. 2) Should I give a code example for each method and object? 3) I recognize 2 different kinds of examples: Some are rather small and right under the object or method description and some are quite long and at the end of a module in a use case. Which kind is encouraged at which conditions? 4) The documentation of the Python Standard Library is quite verbose or like a book / tutorial. Some other documentations like JavaDoc [2] or PerlDoc [3] use a more reference-like documentation. Why did Python choose a different approach? Was this discussed before? 5) Do you have any other advice? Are there things I should be aware of? Regards Ahmet-Serdar Karakaya [1] https://docs.python.org/devguide/documenting.html [2] http://docs.oracle.com/javase/8/docs/api/index.html [3] http://perldoc.perl.org/

1 0

[issue29751] PyLong_FromString fails on decimals with leading zero and base=0
by Serhiy Storchaka 08 Mar '17

08 Mar '17

Changes by Serhiy Storchaka <storchaka+cpython(a)gmail.com>: ---------- assignee: -> docs@python components: +Documentation -Interpreter Core nosy: +docs@python, mark.dickinson type: behavior -> enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29751> _______________________________________

1 0

[issue1283110] Give __len__() advice for "don't know"
by Serhiy Storchaka 08 Mar '17

08 Mar '17

Changes by Serhiy Storchaka <storchaka+cpython(a)gmail.com>: ---------- keywords: +needs review stage: -> patch review status: pending -> open versions: +Python 3.5, Python 3.6, Python 3.7 -Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue1283110> _______________________________________

1 0

[issue25841] In FancyURLopener error in example with http address.
by Denis Savenko 08 Mar '17

08 Mar '17

New submission from Denis Savenko: In documentation from this page https://docs.python.org/3.5/library/urllib.request.html#examples in examples uses default address to python site with http. ( http://python.org/ ). But now python.org use https. When i try use example in ipython i get I/0 error, but error is very simple - http change by https. I found this error on many pages, where use http://python.org/ address, but on FancyURLopener example compiller error very difficult for understanding. ---------- assignee: docs@python components: Documentation messages: 256221 nosy: Denis Savenko, docs@python priority: normal severity: normal status: open title: In FancyURLopener error in example with http address. versions: Python 3.3, Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25841> _______________________________________

4 4

[issue17003] Unification of read() and readline() argument names
by Serhiy Storchaka 08 Mar '17

08 Mar '17

New submission from Serhiy Storchaka: read() and readline() optional parameter which limit the amount of read data has different names in different classes. All this classes mimic (less or more) io classes. Keyword parameter name is a part of method specification. Therefore it will be good made all read() arguments names the same and all readline() arguments names the same (and be consistent with documentation and C implementation). At least we should choose most consistent name for new implementations. If existent C implementation of some method doesn't support keyword argument (all _io classes) or argument names in C and Python implementations are different then we are free to change this name without breaking existing code. For example, read()'s parameter named as: "n" in _pyio, zipfile, and io documentation; "size" in gzip, bz2, imaplib, tarfile, codecs, mailbox; "len" in ssl; "wtd" or "totalwtd" in binhex; "amt" in http/client; "chars" in codecs; "buffersize" in os. readline()'s parameter named as: "limit" in _pyio, zipfile, and io documentation; "size" in gzip, bz2, codecs, mailbox, lzma. ---------- assignee: docs@python components: Documentation, IO, Library (Lib) messages: 180298 nosy: benjamin.peterson, christian.heimes, docs@python, hynek, pitrou, serhiy.storchaka, stutzbach priority: normal severity: normal status: open title: Unification of read() and readline() argument names type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17003> _______________________________________

5 10