]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] gh-130160: use `.. program::` directive for documenting `webbrowser` CLI ...
authordonBarbos <donbarbos@proton.me>
Sun, 9 Mar 2025 07:33:56 +0000 (11:33 +0400)
committerGitHub <noreply@github.com>
Sun, 9 Mar 2025 07:33:56 +0000 (07:33 +0000)
* gh-130160: use `.. program::` directive for documenting `webbrowser` CLI (#130995)

use `.. program::` directive for documenting `webbrowser` CLI

(cherry picked from commit 92e5f826ace1eab29920a0a3487a3cac7eeab925)

* remove extra paragraph

Doc/library/webbrowser.rst

index c34b2170f8f1e38f4662a8802ba5d62e5707700b..9c3ff5efa2ebd20833291a29fce5757fa01b64e2 100644 (file)
@@ -33,11 +33,23 @@ allow the remote browser to maintain its own windows on the display.  If remote
 browsers are not available on Unix, the controlling process will launch a new
 browser and wait.
 
+.. 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`` opens the URL in a new browser window, if possible;
-``-t`` opens the URL in a new browser page ("tab"). The options are,
-naturally, mutually exclusive.  Usage example::
+parameters:
+
+.. 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:
+
+.. code-block:: bash
 
    python -m webbrowser -t "https://www.python.org"