[Python-checkins] bpo-23747: Enhance platform doc, document default behavior (GH-31462)
vstinner
webhook-mailer at python.org
Wed Apr 20 12:23:49 EDT 2022
https://github.com/python/cpython/commit/ad3ca17ff5cd63f907430073b52be27695674148
commit: ad3ca17ff5cd63f907430073b52be27695674148
branch: main
author: slateny <46876382+slateny at users.noreply.github.com>
committer: vstinner <vstinner at python.org>
date: 2022-04-20T18:23:40+02:00
summary:
bpo-23747: Enhance platform doc, document default behavior (GH-31462)
files:
M Doc/library/platform.rst
diff --git a/Doc/library/platform.rst b/Doc/library/platform.rst
index a0eece6c4d8aa..346063d66afab 100644
--- a/Doc/library/platform.rst
+++ b/Doc/library/platform.rst
@@ -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
More information about the Python-checkins
mailing list