From: Mark Dickinson <dickinsm@gmail.com>
Date: Sun, 7 Nov 2010 12:50:11 +0000 (+0000)
Subject: Merged revisions 86293 via svnmerge from
X-Git-Tag: v3.1.3rc1~22
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=bee54f53b1162d2229e15e30156e7f5516cf82ae;p=python

Merged revisions 86293 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r86293 | mark.dickinson | 2010-11-07 12:48:18 +0000 (Sun, 07 Nov 2010) | 1 line

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

diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 011bb6a5a4..783b750e0d 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -466,10 +466,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