gh-123494: Improve documentation for ``webbrowser`` return types (#123495)

Document the return value for ``webbrowser.open*()``.
This commit is contained in:
Aarni Koskela 2024-09-01 08:17:03 +03:00 committed by GitHub
parent 917283ada6
commit 0b6acfee04
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 10 additions and 0 deletions

View File

@ -72,6 +72,8 @@ The following functions are defined:
(note that under many window managers this will occur regardless of the
setting of this variable).
Returns ``True`` if a browser was successfully launched, ``False`` otherwise.
Note that on some platforms, trying to open a filename using this function,
may work and start the operating system's associated program. However, this
is neither supported nor portable.
@ -84,11 +86,16 @@ The following functions are defined:
Open *url* in a new window of the default browser, if possible, otherwise, open
*url* in the only browser window.
Returns ``True`` if a browser was successfully launched, ``False`` otherwise.
.. function:: open_new_tab(url)
Open *url* in a new page ("tab") of the default browser, if possible, otherwise
equivalent to :func:`open_new`.
Returns ``True`` if a browser was successfully launched, ``False`` otherwise.
.. function:: get(using=None)

View File

@ -80,6 +80,9 @@ def open(url, new=0, autoraise=True):
- 1: a new browser window.
- 2: a new browser page ("tab").
If possible, autoraise raises the window (the default) or not.
If opening the browser succeeds, return True.
If there is a problem, return False.
"""
if _tryorder is None:
with _lock: