Skip to content

[3.12] gh-130160: use .. program:: directive for documenting webbrowser CLI (GH-130995) #131004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 9, 2025
Merged

[3.12] gh-130160: use .. program:: directive for documenting webbrowser CLI (GH-130995) #131004

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
096c054
gh-130160: use `.. program::` directive for documenting `webbrowser` …
donBarbos Mar 9, 2025
adced4b
remove extra paragraph
donBarbos Mar 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions Doc/library/webbrowser.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
Loading