From: Mark Dickinson <dickinsm@gmail.com>
Date: Sun, 7 Nov 2010 12:48:18 +0000 (+0000)
Subject: Issue #10145: the float.is_integer method was undocumented.
X-Git-Tag: v3.2a4~86
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4a3c7c4ecf3fef60633c50b3ab07057afdd7fe18;p=python

Issue #10145: the float.is_integer method was undocumented.
---

diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 0ac870be21..9f2831a316 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -530,10 +530,20 @@ The float type has some additional methods.
 
 .. method:: float.as_integer_ratio()
 
-    Return a pair of integers whose ratio is exactly equal to the
-    original float and with a positive denominator.  Raises
-    :exc:`OverflowError` on infinities and a :exc:`ValueError` on
-    NaNs.
+   Return a pair of integers whose ratio is exactly equal to the
+   original float and with a positive denominator.  Raises
+   :exc:`OverflowError` on infinities and a :exc:`ValueError` on
+   NaNs.
+
+.. method:: float.is_integer()
+
+   Return ``True`` if the float instance is finite with integral
+   value, and ``False`` otherwise::
+
+      >>> (-2.0).is_integer()
+      True
+      >>> (3.2).is_integer()
+      False
 
 Two methods support conversion to
 and from hexadecimal strings.  Since Python's floats are stored