]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-92417: `fractions`, `decimal`: Improve docs for alternative constructor methods...
authorAlex Waygood <Alex.Waygood@Gmail.com>
Thu, 19 May 2022 15:28:51 +0000 (16:28 +0100)
committerGitHub <noreply@github.com>
Thu, 19 May 2022 15:28:51 +0000 (17:28 +0200)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Doc/library/decimal.rst
Doc/library/fractions.rst

index 2ad84f20b5560f51c430aa5ee016283703d8237a..d052581c9701243f5f64ce1c0ad7af1c940f0c77 100644 (file)
@@ -571,9 +571,10 @@ Decimal objects
       >>> Decimal(321).exp()
       Decimal('2.561702493119680037517373933E+139')
 
-   .. method:: from_float(f)
+   .. classmethod:: from_float(f)
 
-      Classmethod that converts a float to a decimal number, exactly.
+      Alternative constructor that only accepts instances of :class:`float` or
+      :class:`int`.
 
       Note `Decimal.from_float(0.1)` is not the same as `Decimal('0.1')`.
       Since 0.1 is not exactly representable in binary floating point, the
index c893f2d5389d5793f185fc3a58b81d2f2d0eab81..5f0ecf1f135ea5cfb62403904292ae5da3ce5611 100644 (file)
@@ -114,10 +114,10 @@ another rational number, or from a string.
 
       .. versionadded:: 3.8
 
-   .. method:: from_float(flt)
+   .. classmethod:: from_float(flt)
 
-      This class method constructs a :class:`Fraction` representing the exact
-      value of *flt*, which must be a :class:`float`. Beware that
+      Alternative constructor which only accepts instances of
+      :class:`float` or :class:`numbers.Integral`. Beware that
       ``Fraction.from_float(0.3)`` is not the same value as ``Fraction(3, 10)``.
 
       .. note::
@@ -126,10 +126,10 @@ another rational number, or from a string.
          :class:`Fraction` instance directly from a :class:`float`.
 
 
-   .. method:: from_decimal(dec)
+   .. classmethod:: from_decimal(dec)
 
-      This class method constructs a :class:`Fraction` representing the exact
-      value of *dec*, which must be a :class:`decimal.Decimal` instance.
+      Alternative constructor which only accepts instances of
+      :class:`decimal.Decimal` or :class:`numbers.Integral`.
 
       .. note::