Add docstrings for webbrowser open functions

[bsolomon1124]

BPO	40561
Nosy	@birkenfeld, @terryjreedy, @miss-islington, @bsolomon1124
PRs	bpo-40561: Provide docstrings for public-facing webbrowser functions #19999 [3.8] bpo-40561: Add docstrings for webbrowser open functions (GH-19999) #20036 [3.7] bpo-40561: Add docstrings for webbrowser open functions (GH-19999) #20037

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2020-05-11.19:14:13.434>
created_at = <Date 2020-05-08.12:34:40.944>
labels = ['type-feature', '3.8', '3.9', 'docs']
title = 'Add docstrings for webbrowser open functions'
updated_at = <Date 2020-06-15.22:39:52.894>
user = 'https://github.com/bsolomon1124'

bugs.python.org fields:

activity = <Date 2020-06-15.22:39:52.894>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = True
closed_date = <Date 2020-05-11.19:14:13.434>
closer = 'terry.reedy'
components = ['Documentation']
creation = <Date 2020-05-08.12:34:40.944>
creator = 'bsolomon1124'
dependencies = []
files = []
hgrepos = []
issue_num = 40561
keywords = ['patch']
message_count = 10.0
messages = ['368435', '368482', '368531', '368533', '368552', '368555', '368557', '368639', '368642', '368643']
nosy_count = 5.0
nosy_names = ['georg.brandl', 'terry.reedy', 'docs@python', 'miss-islington', 'bsolomon1124']
pr_nums = ['19999', '20036', '20037']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue40561'
versions = ['Python 3.8', 'Python 3.9']

[bsolomon1124]

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).

[terryjreedy]

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.

[bsolomon1124]

The module source notes "Maintained by Georg Brandl."

[terryjreedy]

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.

[bsolomon1124]

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

[terryjreedy]

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).

[terryjreedy]

Current open doc:
https://docs.python.org/3.9/library/webbrowser.html#webbrowser.open

[terryjreedy]

New changeset ef7973a by Brad Solomon in branch 'master':
bpo-40561: Add docstrings for webbrowser open functions (GH-19999)
ef7973a

[miss-islington]

New changeset 61b49a0 by Miss Islington (bot) in branch '3.7':
bpo-40561: Add docstrings for webbrowser open functions (GH-19999)
61b49a0

[miss-islington]

New changeset a63c611 by Miss Islington (bot) in branch '3.8':
bpo-40561: Add docstrings for webbrowser open functions (GH-19999)
a63c611