Skip to content

[3.10] gh-92417: fractions, decimal: Improve docs for alternative constructor methods (GH-92421) #92971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 19, 2022
+9 −8
Merged

[3.10] gh-92417: fractions, decimal: Improve docs for alternative constructor methods (GH-92421) #92971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions Doc/library/decimal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions Doc/library/fractions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand All @@ -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::

Expand Down