mirror of https://github.com/python/cpython
[3.13] gh-123494: Improve documentation for ``webbrowser`` return types (GH-123495) (#123548)
gh-123494: Improve documentation for ``webbrowser`` return types (GH-123495)
Document the return value for ``webbrowser.open*()``.
(cherry picked from commit 0b6acfee04
)
Co-authored-by: Aarni Koskela <akx@iki.fi>
This commit is contained in:
parent
59a6d48a89
commit
dc06b3d01e
|
@ -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)
|
||||
|
||||
|
|
|
@ -81,6 +81,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:
|
||||
|
|
Loading…
Reference in New Issue