diff options
Diffstat (limited to 'Doc/library/webbrowser.rst')
| -rw-r--r-- | Doc/library/webbrowser.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/Doc/library/webbrowser.rst b/Doc/library/webbrowser.rst index 85d3636..ee501e8 100644 --- a/Doc/library/webbrowser.rst +++ b/Doc/library/webbrowser.rst @@ -83,7 +83,7 @@ The following functions are defined: caller's environment. -.. function:: register(name, constructor, instance=None) +.. function:: register(name, constructor, instance=None, *, preferred=False) Register the browser type *name*. Once a browser type is registered, the :func:`get` function can return a controller for that browser type. If @@ -91,9 +91,11 @@ The following functions are defined: parameters to create an instance when needed. If *instance* is provided, *constructor* will never be called, and may be ``None``. - This entry point is only useful if you plan to either set the :envvar:`BROWSER` - variable or call :func:`get` with a nonempty argument matching the name of a - handler you declare. + Setting *preferred* to ``True`` makes this browser a preferred result for + a :func:`get` call with no argument. Otherwise, this entry point is only + useful if you plan to either set the :envvar:`BROWSER` variable or call + :func:`get` with a nonempty argument matching the name of a handler you + declare. A number of browser types are predefined. This table gives the type names that may be passed to the :func:`get` function and the corresponding instantiations |