Skip to content

Invalid error type in math.factorial sphinx docs/docstring #133904

Closed
Closed
Invalid error type in math.factorial sphinx docs/docstring#133904
Labels
3.13only security fixes3.14bugs and security fixesdocsDocumentation in the Doc direasy

Description

@skirpichev
skirpichev
opened on May 11, 2025

Documentation says: Raises ValueError if n is not integral or is negative.
Docstring: Raise a ValueError if x is negative or non-integral.

State of art:

>>> math.factorial(1.0)
Traceback (most recent call last):
  File "<python-input-2>", line 1, in <module>
    math.factorial(1.0)
    ~~~~~~~~~~~~~~^^^^^
TypeError: 'float' object cannot be interpreted as an integer
>>> math.factorial(-1.0)
Traceback (most recent call last):
  File "<python-input-3>", line 1, in <module>
    math.factorial(-1.0)
    ~~~~~~~~~~~~~~^^^^^^
TypeError: 'float' object cannot be interpreted as an integer
>>> math.factorial(-1)
Traceback (most recent call last):
  File "<python-input-4>", line 1, in <module>
    math.factorial(-1)
    ~~~~~~~~~~~~~~^^^^
ValueError: factorial() not defined for negative values

Documentation should be fixed to state, that TypeError is raised for non-integral arguments.

Or just omit description of exceptions and reduce docs to: "Return factorial of the nonnegative integer n."

Linked PRs

Activity

  1. skirpichev
    added
    docsDocumentation in the Doc dir
    easy
    3.13only security fixes
    3.14bugs and security fixes
    on May 11, 2025
  2. github-project-automation
    added this to docs issueson May 11, 2025
  3. github-project-automation
    moved this to Todo in docs issueson May 11, 2025

  4. StanFromIreland commented on May 11, 2025

    @StanFromIreland
    StanFromIreland
    on May 11, 2025
    Member

    "Return factorial of the nonnegative integer n."

    +1, clear as to what n should be, error should be expected otherwise.

  5. mkaraev commented on May 11, 2025

    @mkaraev
    mkaraev
    on May 11, 2025
    Contributor

    I opened PR
    #133907

  6. StanFromIreland commented on May 11, 2025

    @StanFromIreland
    StanFromIreland
    on May 11, 2025
    Member

    The pr is automatically linked, you do not need to comment it.

  7. abhigyan631
    added a commit that references this issue on May 12, 2025

    Fix incorrect error type in math.factorial documentation (pythonGH-13…

    08c781a
  8. sobolevn
    added a commit that references this issue on May 12, 2025

    gh-133904: Fix `math.factorial` documentation (#133907)

    27ed645
  9. miss-islington
    added a commit that references this issue on May 12, 2025

    pythongh-133904: Fix `math.factorial` documentation (pythonGH-133907)

    43d61f9
  10. sobolevn
    added 2 commits that reference this issue on May 12, 2025

    [3.13] gh-133904: Fix `math.factorial` documentation (GH-133907) (#13…

    532acbd

    [3.14] gh-133904: Fix `math.factorial` documentation (GH-133907) (#13…

    ecc12bf

  11. skirpichev commented on May 12, 2025

    @skirpichev
    skirpichev
    on May 12, 2025
    MemberAuthor

    I think, all merged.

    @mkaraev, congratulations!

  12. skirpichev
    closed this as completedon May 12, 2025

  13. mkaraev commented on May 12, 2025

    @mkaraev
    mkaraev
    on May 12, 2025
    Contributor

    @skirpichev @sobolevn thank you for your help :)

  14. Pranjal095
    added a commit that references this issue on Jul 12, 2025

    pythongh-133904: Fix `math.factorial` documentation (python#133907)

    fb934a2
  15. taegyunkim
    added a commit that references this issue on Aug 4, 2025

    pythongh-133904: Fix `math.factorial` documentation (python#133907)

    14f3251
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.13only security fixes3.14bugs and security fixesdocsDocumentation in the Doc direasy

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions