Skip to content

bpo-23747: Add small note to document default method behavior #31462

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 6 commits into from
Apr 20, 2022
Merged

bpo-23747: Add small note to document default method behavior #31462

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e4b80a3
Update platform.rst
slateny Feb 21, 2022
53793ac
Update platform.rst
slateny Feb 21, 2022
9de23e0
Change as per PR comments
slateny Mar 28, 2022
d3d898d
Remove starting note, added note on function defaults
slateny Apr 10, 2022
9a6aa29
Removed newline
slateny Apr 10, 2022
6d5dd15
Update Doc/library/platform.rst
slateny Apr 20, 2022
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
14 changes: 8 additions & 6 deletions Doc/library/platform.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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

Expand Down