[issue37973] improve docstrings of sys.float_info
New submission from Sergey Fedoseev <fedoseev.sergey@gmail.com>: In [8]: help(sys.float_info) ... | | dig | DBL_DIG -- digits | This is not very helpful, https://docs.python.org/3/library/sys.html#sys.float_info is more verbose, so probably docstrings should be updated from where. ---------- assignee: docs@python components: Documentation messages: 350703 nosy: docs@python, sir-sigurd priority: normal severity: normal status: open title: improve docstrings of sys.float_info type: enhancement _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37973> _______________________________________
Mark Dickinson <dickinsm@gmail.com> added the comment: Unhelpful indeed. +1 to updating those docstrings to match the details at docs.python.org. ---------- nosy: +mark.dickinson _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37973> _______________________________________
Joannah Nanjekye <nanjekyejoannah@gmail.com> added the comment: See also #37970 ---------- nosy: +nanjekyejoannah _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37973> _______________________________________
Mark Dickinson <dickinsm@gmail.com> added the comment: @nanjekyejoannah I'm not seeing how that issue is related to this one (except that they're both about docstrings). Can you elaborate? ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37973> _______________________________________
Joannah Nanjekye <nanjekyejoannah@gmail.com> added the comment: I just referenced another area that may need help updating/improving doc strings. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37973> _______________________________________
Change by Zackery Spytz <zspytz@gmail.com>: ---------- keywords: +patch nosy: +ZackerySpytz nosy_count: 4.0 -> 5.0 pull_requests: +18580 stage: -> patch review pull_request: https://github.com/python/cpython/pull/19218 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37973> _______________________________________
Cheryl Sabella <cheryl.sabella@gmail.com> added the comment: @mark.dickinson, please take a look at the PR when you get a chance. Thanks! ---------- nosy: +cheryl.sabella _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37973> _______________________________________
Mark Dickinson <dickinsm@gmail.com> added the comment: New changeset fdc5a94279736a7715dd35c5354a3c27098d0897 by Zackery Spytz in branch 'master': bpo-37973: Improve the docstrings of sys.float_info (GH-19218) https://github.com/python/cpython/commit/fdc5a94279736a7715dd35c5354a3c27098... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37973> _______________________________________
Mark Dickinson <dickinsm@gmail.com> added the comment: PR applied. Thank you! ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37973> _______________________________________
participants (5)
-
Cheryl Sabella -
Joannah Nanjekye
-
Mark Dickinson
-
Sergey Fedoseev
-
Zackery Spytz