Skip to content

[3.13] gh-122450: Expand documentation for Rational and Fraction (#136800) #137367

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.

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

Open
wants to merge 1 commit into
base: 3.13
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 5 additions & 4 deletions Doc/library/fractions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
The :mod:`fractions` module provides support for rational number arithmetic.


A Fraction instance can be constructed from a pair of integers, from
another rational number, or from a string.
A Fraction instance can be constructed from a pair of rational numbers, from
a single number, or from a string.

.. class:: Fraction(numerator=0, denominator=1)
Fraction(other_fraction)
Expand All @@ -25,7 +25,7 @@ another rational number, or from a string.

The first version requires that *numerator* and *denominator* are instances
of :class:`numbers.Rational` and returns a new :class:`Fraction` instance
with value ``numerator/denominator``. If *denominator* is ``0``, it
with a value equal to ``numerator/denominator``. If *denominator* is zero, it
raises a :exc:`ZeroDivisionError`. The second version requires that
*other_fraction* is an instance of :class:`numbers.Rational` and returns a
:class:`Fraction` instance with the same value. The next two versions accept
Expand Down Expand Up @@ -116,7 +116,8 @@ another rational number, or from a string.

.. attribute:: denominator

Denominator of the Fraction in lowest term.
Denominator of the Fraction in lowest terms.
Guaranteed to be positive.


.. method:: as_integer_ratio()
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/numbers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@ The numeric tower

.. attribute:: numerator

Abstract.
Abstract. The numerator of this rational number.

.. attribute:: denominator

Abstract.
Abstract. The denominator of this rational number.


.. class:: Integral
Expand Down
11 changes: 10 additions & 1 deletion Lib/numbers.py
Original file line number Diff line number Diff line change
Expand Up @@ -290,18 +290,27 @@ def conjugate(self):


class Rational(Real):
""".numerator and .denominator should be in lowest terms."""
"""To Real, Rational adds numerator and denominator properties.

The numerator and denominator values should be in lowest terms,
with a positive denominator.
"""

__slots__ = ()

@property
@abstractmethod
def numerator(self):
"""The numerator of a rational number in lowest terms."""
raise NotImplementedError

@property
@abstractmethod
def denominator(self):
"""The denominator of a rational number in lowest terms.

This denominator should be positive.
"""
raise NotImplementedError

# Concrete implementation of Real's conversion to float.
Expand Down
Loading