Using the `function` argument of `itertools.accumulate()` gets error against the doc
Open
Nobody has claimed this yet.
docs
type-bug
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Bug report
Bug description:
The doc of itertools.accumulate() says the 2nd parameter is function as shown below:
itertools.accumulate(iterable[, function, *, initial=None])
But using function argument gets the error against the doc as shown below:
from itertools import accumulate
from operator import mul
# ↓↓↓↓↓↓↓↓
for x in accumulate(iterable=[1, 2, 3, 4, 5], function=mul):
print(x)
# TypeError: 'function' is an invalid keyword argument for accumulate()
So, I used func argument, then it works as shown below:
from itertools import accumulate
from operator import mul
# ↓↓↓↓
for x in accumulate(iterable=[1, 2, 3, 4, 5], func=mul):
print(x)
# 1
# 2
# 6
# 24
# 120
CPython versions tested on:
3.13
Operating systems tested on:
Windows
Linked PRs
- gh-135283
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the itertools.accumulate() documentation linked in the issue and compare its signature with the accepted keyword shown in the Python examples. Confirm the documented parameter name and update the documentation so the signature matches actual usage; check the linked PR gh-135283 before starting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100