Inacurrate documentation regarding return type of math.factorial

[anntzer]

BPO	37109
Nosy	@csabella, @tirkarthi
Superseder	bpo-25735: math.factorial doc should mention integer return type

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2019-05-31.09:29:34.573>
created_at = <Date 2019-05-31.08:52:17.040>
labels = ['3.8', 'docs']
title = 'Inacurrate documentation regarding return type of math.factorial'
updated_at = <Date 2019-05-31.16:44:19.565>
user = 'https://github.com/anntzer'

bugs.python.org fields:

activity = <Date 2019-05-31.16:44:19.565>
actor = 'cheryl.sabella'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-05-31.09:29:34.573>
closer = 'Antony.Lee'
components = ['Documentation']
creation = <Date 2019-05-31.08:52:17.040>
creator = 'Antony.Lee'
dependencies = []
files = []
hgrepos = []
issue_num = 37109
keywords = []
message_count = 4.0
messages = ['344039', '344046', '344048', '344090']
nosy_count = 3.0
nosy_names = ['docs@python', 'cheryl.sabella', 'xtreak']
pr_nums = []
priority = 'normal'
resolution = 'duplicate'
stage = 'resolved'
status = 'closed'
superseder = '25735'
type = None
url = 'https://bugs.python.org/issue37109'
versions = ['Python 3.8']

[anntzer]

https://docs.python.org/3/library/math.html says

The following functions are provided by this module. Except when explicitly noted otherwise, all return values are floats.

and

math.factorial(x)
Return x factorial. Raises ValueError if x is not integral or is negative.

but math.factorial returns an int (which is perfectly reasonable and just needs to be documented):

In [3]: math.factorial(5)
Out[3]: 120

[tirkarthi]

Is this same as bpo-25735 ?

[anntzer]

oops, missed that, thanks for pointing that out.

[csabella]

Thanks for pointing out the other issue. I've now merged it.