[issue40561] Provide docstrings for public-facing webbrowser functions
New submission from Brad Solomon <brad.solomon.1124@gmail.com>: Currently 'pydoc webbrowser.open' simply displays the function signature without a useful explanation of what 'new' does (and the parameter name/value set is not intuitive by name alone). ---------- assignee: docs@python components: Documentation messages: 368435 nosy: bsolomon1124, docs@python priority: normal severity: normal status: open title: Provide docstrings for public-facing webbrowser functions type: enhancement versions: Python 3.8 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Change by Brad Solomon <brad.solomon.1124@gmail.com>: ---------- keywords: +patch pull_requests: +19312 stage: -> patch review pull_request: https://github.com/python/cpython/pull/19999 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Terry J. Reedy <tjreedy@udel.edu> added the comment: Missing docstrings are almost a bug, but I am not sure if we backport additions. This needs the attention of a coredev to review, approve, and merge, but there is no particular 'webbrowser' maintainer. If no one shows up, you might use git to find those who have most recently committed to the module and request reviews on the PR. ---------- nosy: +terry.reedy versions: +Python 3.9 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Change by Brad Solomon <brad.solomon.1124@gmail.com>: ---------- nosy: +georg.brandl _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Brad Solomon <brad.solomon.1124@gmail.com> added the comment: The module source notes "Maintained by Georg Brandl." ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Terry J. Reedy <tjreedy@udel.edu> added the comment: Except is isn't, as he has been inactive for years. Git log may or may not show more recent commits. My dev machine is being repaired but should be back soon. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Brad Solomon <brad.solomon.1124@gmail.com> added the comment: To no surprise, not a lot of activity with the module over the last few years as it is fairly cut-and-dry. $ git shortlog -sn --since '5 years ago' Lib/webbrowser.py 3 Serhiy Storchaka 1 David Steele 1 Guido van Rossum 1 Michael Haas 1 Nick Coghlan 1 Steve Dower 1 Bumsik Kim 1 Zhiming Wang ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Terry J. Reedy <tjreedy@udel.edu> added the comment: I just got my development machine back, so I will handle this. I first determined that code and doc are same in all 3 versions (except for audit event bit, which I am willing to leave out). ---------- versions: +Python 3.7 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Terry J. Reedy <tjreedy@udel.edu> added the comment: Current open doc: https://docs.python.org/3.9/library/webbrowser.html#webbrowser.open ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Change by Terry J. Reedy <tjreedy@udel.edu>: ---------- title: Provide docstrings for public-facing webbrowser functions -> Add docstrings for webbrowser open functions _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Terry J. Reedy <tjreedy@udel.edu> added the comment: New changeset ef7973a981ff8f4687ef3fdb85a69fa15aa11fe5 by Brad Solomon in branch 'master': bpo-40561: Add docstrings for webbrowser open functions (GH-19999) https://github.com/python/cpython/commit/ef7973a981ff8f4687ef3fdb85a69fa15aa... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- nosy: +miss-islington nosy_count: 4.0 -> 5.0 pull_requests: +19346 pull_request: https://github.com/python/cpython/pull/20036 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +19347 pull_request: https://github.com/python/cpython/pull/20037 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 61b49a00e755136586e991c971c47f38bb5e4d23 by Miss Islington (bot) in branch '3.7': bpo-40561: Add docstrings for webbrowser open functions (GH-19999) https://github.com/python/cpython/commit/61b49a00e755136586e991c971c47f38bb5... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset a63c61168588937c482435d0432c753de4844c46 by Miss Islington (bot) in branch '3.8': bpo-40561: Add docstrings for webbrowser open functions (GH-19999) https://github.com/python/cpython/commit/a63c61168588937c482435d0432c753de48... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Change by Terry J. Reedy <tjreedy@udel.edu>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
Change by Terry J. Reedy <tjreedy@udel.edu>: ---------- versions: -Python 3.7 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40561> _______________________________________
participants (3)
-
Brad Solomon -
miss-islington
-
Terry J. Reedy