Mailman 3 November 2021 - Docs-bugs

[issue45939] PyErr_SetObject documentation lacks mention of reference counting
by Eric Blake Dec. 1, 2021

Dec. 1, 2021

New submission from Eric Blake <eblake(a)redhat.com>: While PyErr_SetString is obvious that you do not have to worry about the reference count of 'exception', the documentation for PyErr_SetObject is silent on whether it steals or adds a reference to 'value'. This is particularly confusing, since other functions on the page (like PyErr_Restore) are explicit about stealing references. Looking at non-canonical documentation, I found https://docstore.mik.ua/orelly/other/python/0596001886_pythonian-chp-24-sec… which claims PyErr_SetObject steals a reference to 'value'. But that is wrong; looking at the source code for _PyErr_SetString, it becomes obvious that once you use SetObject, the reference count will be increased, and the caller can release its own reference because nothing was stolen. I noticed this lack of documentation when trying to debug a memory leak in nbdsh: https://listman.redhat.com/archives/libguestfs/2021-November/msg00280.html ---------- assignee: docs@python components: Documentation messages: 407381 nosy: docs@python, eblake priority: normal severity: normal status: open title: PyErr_SetObject documentation lacks mention of reference counting _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue45939> _______________________________________

3 2

[issue22942] Language Reference - optional comma
by Irit Katriel Nov. 30, 2021

Nov. 30, 2021

Change by Irit Katriel <iritkatriel(a)gmail.com>: ---------- resolution: -> out of date stage: needs patch -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue22942> _______________________________________

1 0

[issue33252] [doc] Clarify ResourceWarning documentation
by Irit Katriel Nov. 30, 2021

Nov. 30, 2021

Irit Katriel <iritkatriel(a)gmail.com> added the comment: It's too late for (b) but (a) still needs to be done. ---------- keywords: +easy nosy: +iritkatriel title: Clarify ResourceWarning documentation -> [doc] Clarify ResourceWarning documentation versions: +Python 3.10, Python 3.11, Python 3.9 -Python 3.4, Python 3.5, Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33252> _______________________________________

1 0

[issue31042] Inconsistency in documentation of operator.index
by Irit Katriel Nov. 30, 2021

Nov. 30, 2021

Irit Katriel <iritkatriel(a)gmail.com> added the comment: My reading of the discussion is that we are not going to make any changes to the docs. Please correct me if I missed anything. ---------- nosy: +iritkatriel resolution: -> rejected status: open -> pending _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue31042> _______________________________________

1 0

[issue16652] [doc] socket.getfqdn docs are not explicit enough about the algorithm.
by Irit Katriel Nov. 30, 2021

Nov. 30, 2021

Irit Katriel <iritkatriel(a)gmail.com> added the comment: There was a recent update nearby in issue40635 by Andrei, but I think it doesn't quite cover this issue. ---------- nosy: +andrei.avk, iritkatriel title: socket.getfqdn docs are not explicit enough about the algorithm. -> [doc] socket.getfqdn docs are not explicit enough about the algorithm. versions: +Python 3.10, Python 3.11, Python 3.9 -Python 2.7, Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue16652> _______________________________________

1 0

[issue25633] The documentation for urllib.request should mention http.client.HTTPException
by Irit Katriel Nov. 30, 2021

Nov. 30, 2021

Irit Katriel <iritkatriel(a)gmail.com> added the comment: Issue22797 was resolved by being more specific about when a URLError is raised, rather than mentioning other exceptions as well. Do we want to do more than that, or can this be closed as well? ---------- nosy: +iritkatriel status: open -> pending _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue25633> _______________________________________

1 0

[issue11352] Update cgi module doc
by Irit Katriel Nov. 30, 2021

Nov. 30, 2021

Irit Katriel <iritkatriel(a)gmail.com> added the comment: Would you like to work on a GitHub PR with these changes? ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue11352> _______________________________________

1 0

[issue11352] Update cgi module doc
by Glenn Linderman Nov. 30, 2021

Nov. 30, 2021

Glenn Linderman <v+python(a)g.nevcal.com> added the comment: Seems like another example of the CGI module not getting much support. While I haven't looked at all the details of the patches, it seems that several people have contributed enhancements or clarifications. and it would be a shame to discard them rather than merge the submissions... but it seems no one with authority wants to support CGI. ---------- status: pending -> open _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue11352> _______________________________________

1 0

[issue27779] Sync-up docstrings in C version of the the decimal module
by Irit Katriel Nov. 30, 2021

Nov. 30, 2021

Change by Irit Katriel <iritkatriel(a)gmail.com>: ---------- assignee: skrah -> keywords: +easy -patch type: -> enhancement versions: +Python 3.11 -Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue27779> _______________________________________

1 0

[issue11352] Update cgi module doc
by Irit Katriel Nov. 30, 2021

Nov. 30, 2021

Irit Katriel <iritkatriel(a)gmail.com> added the comment: Since there was no activity on this for 6-7 years and it's not describing a specific issue, I will close this in a couple of weeks unless someone asks me not to. ---------- nosy: +iritkatriel status: open -> pending _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue11352> _______________________________________

1 0