mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 00:48:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

gh-130160: use .. program:: directive for documenting webbrowser CLI (#130995)

Browse source 
use `.. program::` directive for documenting `webbrowser` CLI
This commit is contained in:
donBarbos 2025-03-09 10:57:59 +04:00 • committed by GitHub
parent a3990df612
commit 92e5f826ac
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

15
Doc/library/webbrowser.rst
View file

@ -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
The options are, naturally, mutually exclusive. Usage example::
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"