Mailman 3 February 2020 - docs

[issue39594] Typo in documentation for os.times
by Chenyoo Hao Feb. 10, 2020

Feb. 10, 2020

New submission from Chenyoo Hao <solitaire2312(a)gmail.com>: 1.Formatting error due to an extra space (After the MSDN link). 2.There are extra words. Original： See the Unix manual page :manpage:`times(2)` and :manpage:`times(3)` manual page on Unix or `the GetProcessTimes MSDN <https://docs.microsoft.com/windows/win32/api/processthreadsapi/nf-processth…>` _ on Windows. On Windows, only :attr:`user` and :attr:`system` are known; the other attributes are zero. After modification： See the manual page :manpage:`times(2)` and :manpage:`times(3)` on Unix or the `GetProcessTimes MSDN <https://docs.microsoft.com/windows/win32/api/processthreadsapi/nf-processth…>`_ on Windows. On Windows, only :attr:`user` and :attr:`system` are known; the other attributes are zero. ---------- assignee: docs@python components: Documentation messages: 361659 nosy: Chenyoo Hao, docs@python priority: normal severity: normal status: open title: Typo in documentation for os.times type: enhancement versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39594> _______________________________________

4 8

[issue39278] add docstrings to functions in pdb module
by Carl Bordum Hansen Feb. 10, 2020

Feb. 10, 2020

New submission from Carl Bordum Hansen <carl(a)bordum.dk>: The functions are documented, but not in doc strings which means you cannot call help() on them. >From this twitter thread: https://twitter.com/raymondh/status/1211414561468952577 ---------- assignee: docs@python components: Documentation messages: 359689 nosy: carlbordum, docs@python priority: normal severity: normal status: open title: add docstrings to functions in pdb module versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39278> _______________________________________

2 2

[issue39501] gettext's default localedir does not match documentation
by Thomas Perret Feb. 10, 2020

Feb. 10, 2020

New submission from Thomas Perret <thomas.perret+python(a)gresille.org>: gettext's documentation (Doc/library/gettext.rst:724) states that default locale directory is: "sys.prefix/share/locale" but the code in gettext module (Lib/gettext.py:63) uses "sys.base_prefix/share/locale" ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 361054 nosy: docs@python, moht priority: normal severity: normal status: open title: gettext's default localedir does not match documentation type: behavior _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39501> _______________________________________

2 1

[issue16776] Document PyCFunction_New and PyCFunction_NewEx functions
by Andrew Svetlov Feb. 10, 2020

Feb. 10, 2020

New submission from Andrew Svetlov: c-api docs has no documentation for those public API functions. ---------- assignee: docs@python components: Documentation keywords: easy messages: 178115 nosy: asvetlov, docs@python priority: normal severity: normal status: open title: Document PyCFunction_New and PyCFunction_NewEx functions type: enhancement versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16776> _______________________________________

7 8

[issue20265] Bring Doc/using/windows up to date
by Zachary Ware Feb. 10, 2020

Feb. 10, 2020

New submission from Zachary Ware: Doc/using/windows still mentions DOS, Windows 3.x, and Python 2.1, and that's just in the first short section. This is a catch-all issue for making sure that page is up to date. ---------- assignee: docs@python components: Documentation, Windows keywords: easy messages: 208136 nosy: docs@python, zach.ware priority: normal severity: normal stage: needs patch status: open title: Bring Doc/using/windows up to date type: enhancement versions: Python 2.7, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue20265> _______________________________________

11 35

[issue39592] Year not updated at python.org
by F4zi Feb. 9, 2020

Feb. 9, 2020

New submission from F4zi <fazbosoreq(a)gmail.com>: The year in https://www.python.org/psf/donations/python-dev/ Should be changed from 2019 to 2020 ---------- assignee: docs@python components: Documentation messages: 361645 nosy: F4zi, docs@python, eric.araujo, ezio.melotti, mdk, willingc priority: normal severity: normal status: open title: Year not updated at python.org _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39592> _______________________________________

2 1

[issue39581] Python Interpreter Doesn't Work Well In Thread Class
by SilentGhost Feb. 8, 2020

Feb. 8, 2020

Change by SilentGhost <ghost.adh(a)runbox.com>: ---------- nosy: +mark.dickinson resolution: -> not a bug stage: -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39581> _______________________________________

1 0

[issue39581] Python Interpreter Doesn't Work Well In Thread Class
by SilentGhost Feb. 8, 2020

Feb. 8, 2020

SilentGhost <ghost.adh(a)runbox.com> added the comment: SyntaxError is produced when there is a syntax problem in the code to be executed, this code is fine from the syntax perspective, so this particular error would not be raised. It is also perfectly fine to have a function call where you have it, the only thing one would need to observe is that the returned value is a callable (or None which would be return value in your case had your function terminated). Perhaps there is an improvement to be made in documentation by way of giving an example, but the solution you're suggesting is not feasible. ---------- assignee: -> docs@python components: +Documentation -Windows nosy: +SilentGhost, docs@python, pitrou -mark.dickinson resolution: not a bug -> stage: resolved -> status: closed -> open _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39581> _______________________________________

1 0

[issue35318] Check accuracy of str() doc string for its encoding argument
by Raymond Hettinger Feb. 8, 2020

Feb. 8, 2020

New submission from Raymond Hettinger <raymond.hettinger(a)gmail.com>: The "encoding" parameter is documented to default to sys.getdefaultencoding(). That may be true but there doesn't seem to be a way to use that default because objects will all have a __str__ or __repr__ that will be run instead. ------------------------------------------- >>> import sys >>> sys.getdefaultencoding() # Default encoding is utf-8 'utf-8' >>> buffer = b'lim x \xe2\x9f\xb6 \xe2\x88\x9e, 1/sin\xc2\xb2(x)' >>> str(buffer, 'utf-8') # Explicit argument decodes properly 'lim x ⟶ ∞, 1/sin²(x)' >>> str(buffer) # Despite the default, repr is shown "b'lim x \\xe2\\x9f\\xb6 \\xe2\\x88\\x9e, 1/sin\\xc2\\xb2(x)'" >>> print(str.__doc__) str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'. ---------- assignee: docs@python components: Documentation messages: 330454 nosy: docs@python, rhettinger priority: normal severity: normal status: open title: Check accuracy of str() doc string for its encoding argument versions: Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue35318> _______________________________________

3 4

[issue39574] str.__doc__ is misleading
by Zachary Westrick Feb. 7, 2020

Feb. 7, 2020

Change by Zachary Westrick <zackzackzackw(a)gmail.com>: ---------- assignee: docs@python components: Documentation nosy: docs@python, kcirtsew priority: normal severity: normal status: open title: str.__doc__ is misleading type: enhancement versions: Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39574> _______________________________________

1 0