aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2009-09-16 15:58:14 +0000
committerGeorg Brandl <georg@python.org>2009-09-16 15:58:14 +0000
commit7f01a13e7c47b6c4bcca601b597378408f3ceb2e (patch)
tree938cccc27452ea421eb5b80521ddd8849661616b /Doc/library/webbrowser.rst
parentUse true booleans and PEP8 for argdefaults. (diff)
downloadcpython-7f01a13e7c47b6c4bcca601b597378408f3ceb2e.tar.gz
cpython-7f01a13e7c47b6c4bcca601b597378408f3ceb2e.tar.bz2
cpython-7f01a13e7c47b6c4bcca601b597378408f3ceb2e.zip
Last round of adapting style of documenting argument default values.
Diffstat (limited to 'Doc/library/webbrowser.rst')
-rw-r--r--Doc/library/webbrowser.rst15
1 files changed, 7 insertions, 8 deletions
diff --git a/Doc/library/webbrowser.rst b/Doc/library/webbrowser.rst
index 01720d126a5..202d7c1a05d 100644
--- a/Doc/library/webbrowser.rst
+++ b/Doc/library/webbrowser.rst
@@ -1,4 +1,3 @@
-
:mod:`webbrowser` --- Convenient Web-browser controller
=======================================================
@@ -46,7 +45,7 @@ The following exception is defined:
The following functions are defined:
-.. function:: open(url[, new=0[, autoraise=True]])
+.. function:: open(url, new=0, autoraise=True)
Display *url* using the default browser. If *new* is 0, the *url* is opened
in the same browser window if possible. If *new* is 1, a new browser window
@@ -72,14 +71,14 @@ The following functions are defined:
equivalent to :func:`open_new`.
-.. function:: get([name])
+.. function:: get(using=None)
- Return a controller object for the browser type *name*. If *name* is empty,
- return a controller for a default browser appropriate to the caller's
- environment.
+ Return a controller object for the browser type *using*. If *using* is
+ ``None``, return a controller for a default browser appropriate to the
+ caller's environment.
-.. function:: register(name, constructor[, instance])
+.. function:: register(name, constructor, instance=None)
Register the browser type *name*. Once a browser type is registered, the
:func:`get` function can return a controller for that browser type. If
@@ -175,7 +174,7 @@ Browser controllers provide these methods which parallel three of the
module-level convenience functions:
-.. method:: controller.open(url[, new[, autoraise=True]])
+.. method:: controller.open(url, new=0, autoraise=True)
Display *url* using the browser handled by this controller. If *new* is 1, a new
browser window is opened if possible. If *new* is 2, a new browser page ("tab")