Mailman 3 June 2017 - docs

[issue26103] Contradiction in definition of "data descriptor" between (dotted lookup behavior/datamodel documentation) and (inspect lib/descriptor how-to)
by Aaron Hall June 5, 2017

June 5, 2017

Aaron Hall added the comment: Bumping this - I intend to work on this next, if no objections. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26103> _______________________________________

1 0

[issue30574] Document why embedding the interpreter can sometimes crash.
by Decorater June 5, 2017

June 5, 2017

New submission from Decorater: According to this example at https://docs.python.org/3/extending/embedding.html#very-high-level-embedding you can use something similar on embedding the interpreter. However for some reason it can crash on Windows and probably some other platforms no matter what python code you enter in the string. I am currently getting that issue on Windows even with the python DLL's being in the same folder of the embedded executable it seems (when I open the crash dump in VS2010 express) that it tried to access an memory address that it has no permissions to. However I have been thinking as to why that might be. The system should have plenty of memory left for it to allocate and run just fine unless it wants to use an already active python process (why would that be when other applications that embed the interpreter seem to work just fine). I think documenting there on when and iff the compiled code crashes with suggestions on how to fix them would be best to do on the page. it could be that the example actually compiles but does not work anymore too. But why would it be on the page if it would compile but crash on any string put into it? Something makes me think the crash is on the Py_DecodeLocale line with the size_t * param being NULL. ---------- assignee: docs@python components: Documentation, Windows messages: 295187 nosy: Decorater, docs@python, paul.moore, steve.dower, tim.golden, zach.ware priority: normal severity: normal status: open title: Document why embedding the interpreter can sometimes crash. versions: Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue30574> _______________________________________

3 10

[issue30538] Functional Programming HOWTO describes one argument itertools.count()
by Cheryl Sabella June 5, 2017

June 5, 2017

New submission from Cheryl Sabella: The Functional Programming HOWTO describes single variable itertools.count instead of the two variable version that is linked to. ---------- assignee: docs@python components: Documentation messages: 294935 nosy: csabella, docs@python priority: normal severity: normal status: open title: Functional Programming HOWTO describes one argument itertools.count() versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue30538> _______________________________________

3 14

[issue30530] Descriptors HowTo: Example on function.__get__ needs update
by Mariano Anaya June 5, 2017

June 5, 2017

New submission from Mariano Anaya: The example on which tries to create a method from the function's __get__ doesn't work for Python 3.5+. It would give this error: TypeError: method expected 2 arguments, got 3 The 3rd parameter, needs to be removed. ---------- assignee: docs@python components: Documentation messages: 294871 nosy: Mariano Anaya, docs@python priority: normal pull_requests: 1967 severity: normal status: open title: Descriptors HowTo: Example on function.__get__ needs update versions: Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue30530> _______________________________________

3 9

[issue29555] Update Python Software Foundation Copyright Year
by Mariatta Wijaya June 5, 2017

June 5, 2017

Changes by Mariatta Wijaya <mariatta.wijaya(a)gmail.com>: ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29555> _______________________________________

1 0

[issue30568] README Formatting
by James Lu June 5, 2017

June 5, 2017

New submission from James Lu: - Shorten the Copyright statement from a list of years (`2001, 2002, 2003, ... 2017`) into `2001-2017` - Extend copyright date at end of README from 2016 to 2017 - Ensure that there are two newlines before every header throughout the file (this was the original format) ---------- assignee: docs@python components: Documentation messages: 295140 nosy: James.Lu, docs@python priority: normal pull_requests: 2020 severity: normal status: open title: README Formatting type: enhancement versions: Python 2.7, Python 3.3, Python 3.4, Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue30568> _______________________________________

3 2

[issue26602] argparse doc introduction is inappropriately targeted
by Daniel Stone June 4, 2017

June 4, 2017

New submission from Daniel Stone: The argparse documentation starts off, after a couple of sentences, by spending several paragraphs (and a couple of sentences) explaining this gem: import argparse parser = argparse.ArgumentParser(description='Process some integers.') parser.add_argument('integers', metavar='N', type=int, nargs='+', help='an integer for the accumulator') parser.add_argument('--sum', dest='accumulate', action='store_const', const=sum, default=max, help='sum the integers (default: find the max)') args = parser.parse_args() print(args.accumulate(args.integers)) While it is undoubtedly impressive, that a sidebar had to be inserted suggesting people in fact refer to other documentation, suggests it may be inappropriate. As an introduction, it is not particularly approachable (especially if you don't catch the nuance of assigning functions to accumulate), and is probably not going to serve the immediate needs of a lot of the audience: the people who click on the first hit for 'python argparse'. I would suggest relegating this example elsewhere in the documentation, with a much more straightforward/realistic example to lead the documentation. ---------- assignee: docs@python components: Documentation messages: 262121 nosy: Daniel Stone, docs@python priority: normal severity: normal status: open title: argparse doc introduction is inappropriately targeted _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26602> _______________________________________

5 4

[issue30558] [Suggestion] Improve documentation for set() API
by Raymond Hettinger June 4, 2017

June 4, 2017

Changes by Raymond Hettinger <raymond.hettinger(a)gmail.com>: ---------- resolution: -> not a bug stage: -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue30558> _______________________________________

1 0

[issue23532] add example of 'first match wins' to regex "|" documentation?
by Raymond Hettinger June 4, 2017

June 4, 2017

Raymond Hettinger added the comment: I concur with Serhiy that the docs correctly and completely describe the behavior. ---------- nosy: +rhettinger status: pending -> open _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23532> _______________________________________

1 0

[issue23532] add example of 'first match wins' to regex "|" documentation?
by Serhiy Storchaka June 4, 2017

June 4, 2017

Serhiy Storchaka added the comment: >From the documentation: """ As the target string is scanned, REs separated by ``'|'`` are tried from left to right. When one pattern completely matches, that branch is accepted. This means that once ``A`` matches, ``B`` will not be tested further, even if it would produce a longer overall match. In other words, the ``'|'`` operator is never greedy. """ I think this completely describes the behavior. ---------- nosy: +serhiy.storchaka resolution: -> not a bug status: open -> pending _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23532> _______________________________________

1 0