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

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

Changes from 1 commit
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
Prev Previous commit
Fix headings
  • Loading branch information
@donbarbos
donbarbos committed May 3, 2025
commit 4aff409e4e588281e50b394c40b24701b87a8cf9
18 changes: 9 additions & 9 deletions Doc/library/platform.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
section.


Cross Platform
Cross platform
--------------


Expand Down Expand Up @@ -188,7 +188,7 @@ Cross Platform
:attr:`processor` is resolved late instead of immediately.


Java Platform
Java platform
-------------


Expand All @@ -206,7 +206,7 @@ Java Platform
and was only useful for Jython support.


Windows Platform
Windows platform
----------------


Expand Down Expand Up @@ -240,7 +240,7 @@ Windows Platform
.. versionadded:: 3.8


macOS Platform
macOS platform
--------------

.. function:: mac_ver(release='', versioninfo=('','',''), machine='')
Expand All @@ -252,7 +252,7 @@ macOS Platform
Entries which cannot be determined are set to ``''``. All tuple entries are
strings.

iOS Platform
iOS platform
------------

.. function:: ios_ver(system='', release='', model='', is_simulator=False)
Expand All @@ -271,7 +271,7 @@ iOS Platform
parameters.


Unix Platforms
Unix platforms
--------------

.. function:: libc_ver(executable=sys.executable, lib='', version='', chunksize=16384)
Expand All @@ -287,7 +287,7 @@ Unix Platforms
The file is read and scanned in chunks of *chunksize* bytes.


Linux Platforms
Linux platforms
---------------

.. function:: freedesktop_os_release()
Expand Down Expand Up @@ -325,7 +325,7 @@ Linux Platforms
.. versionadded:: 3.10


Android Platform
Android platform
----------------

.. function:: android_ver(release="", api_level=0, manufacturer="", \
Expand Down Expand Up @@ -362,7 +362,7 @@ Android Platform

.. _platform-cli:

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

:mod:`platform` can also be invoked directly using the :option:`-m`
Expand Down