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.

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
Show file tree
Hide file tree
Changes from 7 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
17 changes: 4 additions & 13 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 numbers, from
another 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 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 @@ -119,15 +119,6 @@ another rational number, or from a string.
The :class:`Fraction` constructor now accepts any objects with the
:meth:`!as_integer_ratio` method.

.. attribute:: numerator

Numerator of the Fraction in lowest term.

.. attribute:: denominator

Denominator of the Fraction in lowest term.


.. method:: as_integer_ratio()

Return a tuple of two integers, whose ratio is equal
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
8 changes: 7 additions & 1 deletion Lib/numbers.py
Original file line number Diff line number Diff line change
Expand Up @@ -290,18 +290,24 @@ def conjugate(self):


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

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

__slots__ = ()

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

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

# Concrete implementation of Real's conversion to float.
Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy