Skip to content

gh-122450: Expand documentation for Rational and Fraction #136800

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 14 commits into from
Aug 4, 2025
Merged

gh-122450: Expand documentation for Rational and Fraction #136800

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
762e14c
gh-122450: Expand numbers.Rational docstrings
skirpichev Jul 19, 2025
7e3b3dc
Merge branch 'master' into numden-props/122450
skirpichev Jul 19, 2025
478e414
Revert "gh-122450: Indicate that `Fraction` denominators are always p…
skirpichev Jul 19, 2025
c3f506a
Document Ratiomal.numerator/denominator, remove from Fraction docs
skirpichev Jul 19, 2025
12d7786
Merge branch 'master' into numden-props/122450
skirpichev Jul 21, 2025
f2aaed3
address review: more vague preable
skirpichev Jul 21, 2025
a8b6ca2
address review: 0 -> zero
skirpichev Jul 21, 2025
53e8c26
Apply suggestions from code review
skirpichev Jul 21, 2025
fb84af4
address review: restore Fraction.numerator/denominator in docs
skirpichev Jul 21, 2025
6e61673
Merge branch 'master' into numden-props/122450
skirpichev Jul 21, 2025
668518d
Update Doc/library/fractions.rst
skirpichev Jul 31, 2025
b4bdda2
Add an explicit reference to conversion of constructor arguments
AA-Turner Jul 31, 2025
f558851
Update Doc/library/fractions.rst
skirpichev Jul 31, 2025
ec9c6f8
Update Doc/library/fractions.rst
skirpichev Aug 4, 2025
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
11 changes: 6 additions & 5 deletions Doc/library/fractions.rst
View file
Open in desktop
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.

.. index:: single: as_integer_ratio()

Expand All @@ -25,8 +25,8 @@ 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 equal to ``numerator/denominator`` where the denominator is positive.
If *denominator* is ``0``, it raises a :exc:`ZeroDivisionError`.
with a value equal to ``numerator/denominator``.
If *denominator* is zero, it raises a :exc:`ZeroDivisionError`.

The second version requires that *number* is an instance of
:class:`numbers.Rational` or has the :meth:`!as_integer_ratio` method
Expand Down Expand Up @@ -125,7 +125,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
View file
Open in desktop
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
View file
Open in desktop
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