diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2022-05-19 15:45:30 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-19 15:45:30 (GMT) |
| commit | 93ebac7a79c055b6122ef086000b456361388dd9 (patch) | |
| tree | e9bb53e0d00216c9dad528170c33658391c0c522 | |
| parent | ebf3f12c389c6d9cedf54c5daac065de3ef53256 (diff) | |
| download | cpython-93ebac7a79c055b6122ef086000b456361388dd9.zip cpython-93ebac7a79c055b6122ef086000b456361388dd9.tar.gz cpython-93ebac7a79c055b6122ef086000b456361388dd9.tar.bz2 | |
gh-92417: `fractions`, `decimal`: Improve docs for alternative constructor methods (GH-92421) (GH-92971)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 090df844ea16af3a5df79aba2b9c89ac6a31ba06)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
| -rw-r--r-- | Doc/library/decimal.rst | 5 | ||||
| -rw-r--r-- | Doc/library/fractions.rst | 12 |
2 files changed, 9 insertions, 8 deletions
diff --git a/Doc/library/decimal.rst b/Doc/library/decimal.rst index e759c5c..47627c0 100644 --- a/Doc/library/decimal.rst +++ b/Doc/library/decimal.rst @@ -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 diff --git a/Doc/library/fractions.rst b/Doc/library/fractions.rst index a4d006e..0f7940a 100644 --- a/Doc/library/fractions.rst +++ b/Doc/library/fractions.rst @@ -105,10 +105,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:: @@ -117,10 +117,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:: |