Revert int.as_integer_ration() docstring/rst docs to the original patch

python · mdickinson · Feb 27, 2023 · Feb 12, 2023 · Feb 12, 2023 · Feb 12, 2023
commit fdb47d277f3b374e23adc7f8d22f5427f5f1ae63
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
@@ -602,7 +602,10 @@ class`. In addition, it provides a few more methods:
 
 .. method:: int.as_integer_ratio()
 
-   Given an integer ``x``, return the tuple ``(int(x), 1)``.
+   Return a pair of integers whose ratio is equal to the original
+   integer and has a positive denominator.  The integer ratio of integers
+   (whole numbers) is always the integer as the numerator and ``1`` as the
+   denominator.
 
    .. versionadded:: 3.8
 

diff --git a/Lib/test/test_doctest.py b/Lib/test/test_doctest.py
@@ -711,7 +711,7 @@ def non_Python_modules(): r"""
     True
     >>> real_tests = [t for t in tests if len(t.examples) > 0]
     >>> len(real_tests) # objects that actually have doctests
-    13
+    14
     >>> for t in real_tests:
     ...     print('{}  {}'.format(len(t.examples), t.name))
     ...
@@ -723,6 +723,7 @@ def non_Python_modules(): r"""
     2  builtins.float.hex
     1  builtins.hex
     1  builtins.int
+    3  builtins.int.as_integer_ratio
     2  builtins.int.bit_count
     2  builtins.int.bit_length
     5  builtins.memoryview.hex

diff --git a/Objects/clinic/longobject.c.h b/Objects/clinic/longobject.c.h
diff --git a/Objects/longobject.c b/Objects/longobject.c
@@ -6020,12 +6020,21 @@ int_bit_count_impl(PyObject *self)
 /*[clinic input]
 int.as_integer_ratio
 
-Given an integer x, return the tuple (int(x), 1).
+Return a pair of integers, whose ratio is equal to the original int.
+
+The ratio is in lowest terms and has a positive denominator.
+
+>>> (10).as_integer_ratio()
+(10, 1)
+>>> (-10).as_integer_ratio()
+(-10, 1)
+>>> (0).as_integer_ratio()
+(0, 1)
 [clinic start generated code]*/
 
 static PyObject *
 int_as_integer_ratio_impl(PyObject *self)
-/*[clinic end generated code: output=e60803ae1cc8621a input=258f5b08307e7dcd]*/
+/*[clinic end generated code: output=e60803ae1cc8621a input=384ff1766634bec2]*/
 {
     PyObject *ratio_tuple;
     PyObject *numerator = long_long(self);