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

bpo-23747: Enhance platform doc, document default behavior (GH-31462)

Browse source
This commit is contained in:
slateny 2022-04-20 09:23:40 -07:00 • committed by GitHub
parent d7d7e6c007
commit ad3ca17ff5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Doc/library/platform.rst
View file

@ -139,7 +139,7 @@ Cross Platform
.. function:: release()
Returns the system's release, e.g. ``'2.2.0'`` or ``'NT'`` An empty string is
Returns the system's release, e.g. ``'2.2.0'`` or ``'NT'``. An empty string is
returned if the value cannot be determined.
@ -176,7 +176,7 @@ Cross Platform
Entries which cannot be determined are set to ``''``.
.. versionchanged:: 3.3
Result changed from a tuple to a namedtuple.
Result changed from a tuple to a :func:`~collections.namedtuple`.
Java Platform
@ -201,7 +201,9 @@ Windows Platform
Get additional version information from the Windows Registry and return a tuple
``(release, version, csd, ptype)`` referring to OS release, version number,
CSD level (service pack) and OS type (multi/single processor).
CSD level (service pack) and OS type (multi/single processor). Values which
cannot be determined are set to the defaults given as parameters (which all
default to an empty string).
As a hint: *ptype* is ``'Uniprocessor Free'`` on single processor NT machines
and ``'Multiprocessor Free'`` on multi processor machines. The *'Free'* refers
@ -211,9 +213,9 @@ Windows Platform
.. function:: win32_edition()
Returns a string representing the current Windows edition. Possible
values include but are not limited to ``'Enterprise'``, ``'IoTUAP'``,
``'ServerStandard'``, and ``'nanoserver'``.
Returns a string representing the current Windows edition, or ``None`` if the
value cannot be determined. Possible values include but are not limited to
``'Enterprise'``, ``'IoTUAP'``, ``'ServerStandard'``, and ``'nanoserver'``.
.. versionadded:: 3.8