Skip to content

Commit

Permalink
bpo-40561: Add docstrings for webbrowser open functions (pythonGH-19999)
Browse files Browse the repository at this point in the history
Co-authored-by: Brad Solomon <brsolomon@deloitte.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit ef7973a)

Co-authored-by: Brad Solomon <brad.solomon.1124@gmail.com>
  • Loading branch information
miss-islington and bsolomon1124 authored May 11, 2020
1 parent 5d555fa commit 61b49a0
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
16 changes: 16 additions & 0 deletions Lib/webbrowser.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,14 @@ def get(using=None):
# instead of "from webbrowser import *".

def open(url, new=0, autoraise=True):
"""Display url using the default browser.
If possible, open url in a location determined by new.
- 0: the same browser window (the default).
- 1: a new browser window.
- 2: a new browser page ("tab").
If possible, autoraise raises the window (the default) or not.
"""
if _tryorder is None:
with _lock:
if _tryorder is None:
Expand All @@ -80,9 +88,17 @@ def open(url, new=0, autoraise=True):
return False

def open_new(url):
"""Open url in a new window of the default browser.
If not possible, then open url in the only browser window.
"""
return open(url, 1)

def open_new_tab(url):
"""Open url in a new page ("tab") of the default browser.
If not possible, then the behavior becomes equivalent to open_new().
"""
return open(url, 2)


Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Provide docstrings for webbrowser open functions.

0 comments on commit 61b49a0

Please sign in to comment.