Skip to content

Commit d3d898d

Browse files
committed
Remove starting note, added note on function defaults
1 parent 9de23e0 commit d3d898d

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

Doc/library/platform.rst

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,6 @@
1717
section.
1818

1919

20-
.. note::
21-
22-
Calling a platform-specific method on a mismatched platform will return their
23-
default values, such as a tuple with empty string values.
24-
2520

2621
Cross Platform
2722
--------------
@@ -145,7 +140,7 @@ Cross Platform
145140

146141
.. function:: release()
147142

148-
Returns the system's release, e.g. ``'2.2.0'`` or ``'NT'`` An empty string is
143+
Returns the system's release, e.g. ``'2.2.0'`` or ``'NT'``. An empty string is
149144
returned if the value cannot be determined.
150145

151146

@@ -182,7 +177,7 @@ Cross Platform
182177
Entries which cannot be determined are set to ``''``.
183178

184179
.. versionchanged:: 3.3
185-
Result changed from a tuple to a namedtuple.
180+
Result changed from a tuple to a :func:`~collections.namedtuple`.
186181

187182

188183
Java Platform
@@ -207,7 +202,9 @@ Windows Platform
207202

208203
Get additional version information from the Windows Registry and return a tuple
209204
``(release, version, csd, ptype)`` referring to OS release, version number,
210-
CSD level (service pack) and OS type (multi/single processor).
205+
CSD level (service pack) and OS type (multi/single processor). Values which
206+
cannot be determined are set to the defaults given as parameters (which all
207+
default to ``''``).
211208

212209
As a hint: *ptype* is ``'Uniprocessor Free'`` on single processor NT machines
213210
and ``'Multiprocessor Free'`` on multi processor machines. The *'Free'* refers
@@ -217,9 +214,9 @@ Windows Platform
217214

218215
.. function:: win32_edition()
219216

220-
Returns a string representing the current Windows edition. Possible
221-
values include but are not limited to ``'Enterprise'``, ``'IoTUAP'``,
222-
``'ServerStandard'``, and ``'nanoserver'``.
217+
Returns a string representing the current Windows edition, or ``None`` if the
218+
value cannot be determined. Possible values include but are not limited to
219+
``'Enterprise'``, ``'IoTUAP'``, ``'ServerStandard'``, and ``'nanoserver'``.
223220

224221
.. versionadded:: 3.8
225222

0 commit comments

Comments
 (0)