[Python-checkins] bpo-25735: math.factorial doc should mention integer return type (GH-6420)

Miss Islington (bot) webhook-mailer at python.org
Fri May 31 12:58:31 EDT 2019


https://github.com/python/cpython/commit/fc3b8437c86167983cc75e5a9a3ed1dc542a1b79
commit: fc3b8437c86167983cc75e5a9a3ed1dc542a1b79
branch: 3.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-05-31T09:58:27-07:00
summary:

bpo-25735: math.factorial doc should mention integer return type (GH-6420)

(cherry picked from commit 4612671df2742eade8ecf8003a6ce1247973c135)

Co-authored-by: Akshay Sharma <akshay.sharma09695 at gmail.com>

files:
A Misc/NEWS.d/next/Documentation/2018-04-08-19-09-22.bpo-25735.idVQBD.rst
M Doc/library/math.rst

diff --git a/Doc/library/math.rst b/Doc/library/math.rst
index b06b054d516a..fd96d7a95864 100644
--- a/Doc/library/math.rst
+++ b/Doc/library/math.rst
@@ -50,7 +50,7 @@ Number-theoretic and representation functions
 
 .. function:: factorial(x)
 
-   Return *x* factorial.  Raises :exc:`ValueError` if *x* is not integral or
+   Return *x* factorial as an integer.  Raises :exc:`ValueError` if *x* is not integral or
    is negative.
 
 
diff --git a/Misc/NEWS.d/next/Documentation/2018-04-08-19-09-22.bpo-25735.idVQBD.rst b/Misc/NEWS.d/next/Documentation/2018-04-08-19-09-22.bpo-25735.idVQBD.rst
new file mode 100644
index 000000000000..8d22cf69e170
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2018-04-08-19-09-22.bpo-25735.idVQBD.rst
@@ -0,0 +1 @@
+Added documentation for func factorial to indicate that returns integer values



More information about the Python-checkins mailing list