Skip to content

gh-130160: use .. program:: directive for documenting platform CLI #133335

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 5 commits into from
May 3, 2025
Merged

gh-130160: use .. program:: directive for documenting platform CLI #133335

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a0de96c
use `.. program::` directive for documenting `platform` CLI
donBarbos May 3, 2025
dea95f7
Fix func link
donBarbos May 3, 2025
4513a95
Add `.. versionadded::` directive
donBarbos May 3, 2025
1804969
Revert "Add `.. versionadded::` directive"
donBarbos May 3, 2025
4aff409
Fix headings
donBarbos May 3, 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
2 changes: 1 addition & 1 deletion Doc/library/cmdline.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The following modules have a command-line interface.
* :mod:`pdb`
* :ref:`pickle <pickle-cli>`
* :ref:`pickletools <pickletools-cli>`
* :mod:`platform`
* :ref:`platform <platform-cli>`
* :mod:`poplib`
* :ref:`profile <profile-cli>`
* :mod:`pstats`
Expand Down
28 changes: 28 additions & 0 deletions Doc/library/platform.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,34 @@ Android Platform

.. versionadded:: 3.13

.. _platform-cli:

Command-line Usage
------------------

:mod:`platform` can also be invoked directly using the :option:`-m`
switch of the interpreter::

python -m platform [--terse] [--nonaliased] [{nonaliased,terse} ...]

The following options are accepted:

.. program:: platform

.. option:: --terse

Print terse information about the platform. This is equivalent to
calling :func:`platform.platform` with the *terse* argument set to ``True``.

.. option:: --nonaliased

Print platform information without system/OS name aliasing. This is
equivalent to calling :func:`platform.platform` with the *aliased* argument
set to ``True``.

You can also pass one or more positional arguments (``terse``, ``nonaliased``)
to explicitly control the output format. These behave similarly to their
corresponding options.

Miscellaneous
-------------
Expand Down
Loading