Skip to content

Commit 3c5edb5

Browse files
Apply suggestions from code review
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
1 parent 9d8f7b2 commit 3c5edb5

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

Doc/c-api/float.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -157,25 +157,27 @@ Floating-Point Objects
157157
158158
.. c:macro:: Py_IS_FINITE(X)
159159
160-
Determines if the given floating-point number *X* has finite value,
161-
that is, it is normal, subnormal or zero, but not infinite or NaN.
160+
Return ``1`` if the given floating-point number *X* is finite,
161+
that is, it is normal, subnormal or zero, but not infinite or NaN;
162+
else ``0``.
162163
163164
.. deprecated:: 3.14
164165
The macro is :term:`soft deprecated`. Use :c:macro:`!isfinite` instead.
165166
166167
167168
.. c:macro:: Py_IS_INFINITY(X)
168169
169-
Determines if the given floating-point number *X* is positive or negative
170-
infinity.
170+
Return ``1`` if the given floating-point number *X* is positive or negative
171+
infinity, else ``0``.
171172
172173
.. deprecated:: 3.14
173174
The macro is :term:`soft deprecated`. Use :c:macro:`!isinf` instead.
174175
175176
176177
.. c:macro:: Py_IS_NAN(X)
177178
178-
Determines if the given floating-point number *X* is a not-a-number (NaN) value.
179+
Return ``1`` if the given floating-point number *X* is a not-a-number (NaN) value,
180+
else ``0``.
179181
180182
.. deprecated:: 3.14
181183
The macro is :term:`soft deprecated`. Use :c:macro:`!isnan` instead.

0 commit comments

Comments
 (0)