From 3f4118a9ef5d468eb296fb248363d71a4c8eb2ee Mon Sep 17 00:00:00 2001 From: donBarbos Date: Sat, 8 Mar 2025 17:54:51 +0400 Subject: [PATCH] use `.. program::` directive for documenting `webbrowser` CLI --- Doc/library/webbrowser.rst | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/Doc/library/webbrowser.rst b/Doc/library/webbrowser.rst index 2d19c514ce43b6..d33e7344761f4a 100644 --- a/Doc/library/webbrowser.rst +++ b/Doc/library/webbrowser.rst @@ -40,14 +40,23 @@ a new tab, with the browser being brought to the foreground. The use of the :mod:`webbrowser` module on iOS requires the :mod:`ctypes` module. If :mod:`ctypes` isn't available, calls to :func:`.open` will fail. +.. program:: webbrowser + The script :program:`webbrowser` can be used as a command-line interface for the module. It accepts a URL as the argument. It accepts the following optional parameters: -* ``-n``/``--new-window`` opens the URL in a new browser window, if possible. -* ``-t``/``--new-tab`` opens the URL in a new browser page ("tab"). +.. option:: -n, --new-window + + Opens the URL in a new browser window, if possible. + +.. option:: -t, --new-tab + + Opens the URL in a new browser tab. + +The options are, naturally, mutually exclusive. Usage example: -The options are, naturally, mutually exclusive. Usage example:: +.. code-block:: bash python -m webbrowser -t "https://www.python.org"