]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-23747: Enhance platform doc, document default behavior (GH-31462)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 20 Apr 2022 16:48:04 +0000 (09:48 -0700)
committerGitHub <noreply@github.com>
Wed, 20 Apr 2022 16:48:04 +0000 (09:48 -0700)
(cherry picked from commit ad3ca17ff5cd63f907430073b52be27695674148)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
Doc/library/platform.rst

index d87205c3d4af86660a0ab59424460fbee517810e..722a5b59e3e7e2bbe3e67bb1d904112a440fd53a 100644 (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