Mailman 3 May 2016 - docs

[issue21528] Fix a number of typos in the documentation
by Alex Gaynor May 26, 2016

May 26, 2016

New submission from Alex Gaynor: Attached patch is against the default branch, and fixes a number of typos. ---------- assignee: docs@python components: Documentation files: typos.diff keywords: needs review, patch messages: 218769 nosy: alex, docs@python priority: normal severity: normal status: open title: Fix a number of typos in the documentation versions: Python 3.5 Added file: http://bugs.python.org/file35289/typos.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21528> _______________________________________

4 5

sqlite3 open parameter "check_same_thread" not documented (issue 27113)
by thomas＠kluyver.me.uk May 25, 2016

May 25, 2016

http://bugs.python.org/review/27113/diff/17342/Doc/library/sqlite3.rst File Doc/library/sqlite3.rst (right): http://bugs.python.org/review/27113/diff/17342/Doc/library/sqlite3.rst#newc… Doc/library/sqlite3.rst:194: a connection from multiple threads. Be sure to use SQLite version 3.3.1 or later This version was released over a decade ago (https://www.sqlite.org/chronology.html) - is it necessary to mention the requirement? And if it is, can we include an indication that you almost certainly have a new enough version, so people don't need to work out how to find their sqlite version. http://bugs.python.org/review/27113/diff/17342/Doc/library/sqlite3.rst#newc… Doc/library/sqlite3.rst:195: and use locking when writing to the connection to avoid corruption. According to the sqlite docs (http://www.sqlite.org/threadsafe.html), the default mode is 'serialized', which does the necessary locking for threads to share a connection. Unless Python is overriding this to use one of the less protected modes, it shouldn't be necessary to use extra locks around it. http://bugs.python.org/review/27113/

1 0

[issue16509] sqlite3 docs do not explain check_same_thread
by Daniel Micay May 25, 2016

May 25, 2016

New submission from Daniel Micay: The sqlite3 documentation now includes a Multithreading section explaining issues with older sqlite versions, but still doesn't directly cover disabling check_same_thread beyond listing it as a possible parameter. As far as I can tell, reusing sqlite connections in different threads (such as from a pool) is safe, as long as no attempt is made to use them from multiple threads with no locking. ---------- assignee: docs@python components: Documentation messages: 175946 nosy: docs@python, strcat priority: normal severity: normal status: open title: sqlite3 docs do not explain check_same_thread type: enhancement versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16509> _______________________________________

6 7

[issue27116] Documentation for regular expression alphanumeric matching are swapped. https://docs.python.org/2/library/re.html#regular-expression-syntax
by dananntang May 25, 2016

May 25, 2016

New submission from dananntang: https://docs.python.org/2/library/re.html#regular-expression-syntax Section 7.2.1. Regular Expression Syntax Documentation for \w and \W are wrong. To be specific: \w is to match any non-alphanumeric character, while \W is to match alphanumeric character Fix: swap documentation for \w and \W ---------- assignee: docs@python components: Documentation messages: 266291 nosy: dananntang, docs@python priority: normal severity: normal status: open title: Documentation for regular expression alphanumeric matching are swapped. https://docs.python.org/2/library/re.html#regular-expression-syntax versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27116> _______________________________________

3 2

[issue17866] TestCase.assertItemsEqual exists in 2.7, not in 3.3
by R. David Murray May 23, 2016

May 23, 2016

R. David Murray added the comment: At the time I wanted it to be named assertCountsEqual, which is better (IMO) than either assertItemsEqual or assertCountEqual. I lost that naming contest, though :(. On the third hand, I don't think there exists a good two word name for what the function does. ---------- nosy: +r.david.murray _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17866> _______________________________________

1 0

[issue20699] Document that binary IO classes work with bytes-likes objects
by Serhiy Storchaka May 22, 2016

May 22, 2016

Serhiy Storchaka added the comment: bytes-like-param.v6.patch LGTM. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue20699> _______________________________________

1 0

[issue20699] Document that binary IO classes work with bytes-likes objects
by Martin Panter May 22, 2016

May 22, 2016

Martin Panter added the comment: I updated my patch thanks to Serhiy’s comments. Also omitted Arg Clinic generated code in this version to avoid future merge conflicts with the hashes. ---------- versions: +Python 3.6 -Python 3.4 Added file: http://bugs.python.org/file42934/bytes-like-param.v6.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue20699> _______________________________________

1 0

Re: [docs] Behavior of ZipFile with file-like object and BufferedWriter. (issue 20699)
by vadmium+py＠gmail.com May 22, 2016

May 22, 2016

https://bugs.python.org/review/20699/diff/16966/Doc/library/io.rst File Doc/library/io.rst (right): https://bugs.python.org/review/20699/diff/16966/Doc/library/io.rst#newcode5… Doc/library/io.rst:597: The argument *initial_bytes* is a :term:`bytes-like object` that On 2016/05/19 08:45:20, storchaka wrote: > Maybe "The optional argument"? Sure https://bugs.python.org/review/20699/diff/16966/Lib/_pyio.py File Lib/_pyio.py (right): https://bugs.python.org/review/20699/diff/16966/Lib/_pyio.py#newcode678 Lib/_pyio.py:678: """Read bytes into buffer *b*, using at most one system call On 2016/05/19 08:45:20, storchaka wrote: > Should this be unified with readinto()? I don’t want to copy the wording from readinto(), because I want to keep the first line of the doc string a short summary (while still mentioning “one system call”). https://bugs.python.org/review/20699/diff/16966/Lib/test/test_io.py File Lib/test/test_io.py (right): https://bugs.python.org/review/20699/diff/16966/Lib/test/test_io.py#newcode… Lib/test/test_io.py:320: self.assertEqual(memoryview(data).tobytes(), b" worl") On 2016/05/19 08:45:20, storchaka wrote: > Maybe just "bytes(data)"? I probably wrote the longer version with Python 2 compatibility in mind. But I see that neither of my byteslike() functions will work as they are with Python 2, so I may as well use the simpler version. https://bugs.python.org/review/20699/diff/16966/Lib/test/test_io.py#newcode… Lib/test/test_io.py:667: def make_file_writer(): On 2016/05/19 08:45:20, storchaka wrote: > Yet more short and clear writing is: > > def check(f): > with f: > self.assertEqual(f.write(a), n) > f.writelines((a,)) > check(self.BytesIO()) > check(self.FileIO(support.TESTFN, "w")) > ... > > Only 9 lines! Thankyou, I used this version https://bugs.python.org/review/20699/

1 0

[issue27075] Link to StreamReader/Writer from codecs.getreader/writer
by Ville Skyttä May 21, 2016

May 21, 2016

New submission from Ville Skyttä: Patch attached. ---------- assignee: docs@python components: Documentation files: codeclinks.patch keywords: patch messages: 265991 nosy: docs@python, scop priority: normal severity: normal status: open title: Link to StreamReader/Writer from codecs.getreader/writer type: enhancement Added file: http://bugs.python.org/file42923/codeclinks.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27075> _______________________________________

3 2

Doc and comment spelling fixes (issue 27076)
by vadmium+py＠gmail.com May 21, 2016

May 21, 2016

https://bugs.python.org/review/27076/diff/17296/Lib/numbers.py File Lib/numbers.py (left): https://bugs.python.org/review/27076/diff/17296/Lib/numbers.py#oldcode38 Lib/numbers.py:38: If it is given heterogenous arguments, and doesn't have special I understand the original is also a valid spelling, so we should probably leave this alone. https://bugs.python.org/review/27076/diff/17296/Lib/unittest/test/test_case… File Lib/unittest/test/test_case.py (left): https://bugs.python.org/review/27076/diff/17296/Lib/unittest/test/test_case… Lib/unittest/test/test_case.py:945: # comparing heterogenous non-hashable sequences See other comment about “heterogenous” https://bugs.python.org/review/27076/

1 0