8000 bpo-40806: itertools.product docs clarify by stsouko · Pull Request #20492 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

bpo-40806: itertools.product docs clarify #20492

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
May 28, 2020
Merged

bpo-40806: itertools.product docs clarify #20492

merged 4 commits into from
May 28, 2020

Conversation

stsouko
Copy link
Contributor
@stsouko stsouko commented May 28, 2020 •
edited by bedevere-bot
Loading

Explanation of arguments of product function added.

https://bugs.python.org/issue40806

@stsouko stsouko requested a review from rhettinger as a code owner May 28, 2020 15:34
@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

CLA Missing

Our records indicate the following people have not signed the CLA:

@stsouko

For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels May 28, 2020
@rhettinger rhettinger self-assigned this May 28, 2020
@stsouko
Copy link
Contributor Author
stsouko commented May 28, 2020

I don't know why Docs / Docs (pull_request) test failed

@rhettinger
Copy link
Contributor

Standby, I'm working on a fix.

@rhettinger
* Fix bad markup which was being rejected by the buildbots.
b9fcccb 
* Switch to an affirmative tone as required by the dev guide.
@rhettinger rhettinger merged commit cfc6ce4 into python:master May 28, 2020
@miss-islington
Copy link
Contributor

Thanks @stsouko for the PR, and @rhettinger for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-20498 is a backport of this pull request to the 3.9 branch.

rhettinger pushed a commit that referenced this pull request May 28, 2020
@miss-islington
bpo-40806: itertools.product immediately consumes its inputs (GH-20492)…
e4cc3a7 
… (GH-20498)
CuriousLearner added a commit to CuriousLearner/cpython that referenced this pull request May 30, 2020
@CuriousLearner
Merge branch 'master' of github.com:python/cpython into bpo-26543
d3d7100 
* 'master' of github.com:python/cpython: (497 commits)
  bpo-40061: Fix a possible refleak in _asynciomodule.c (pythonGH-19748)
  bpo-40798: Generate a different message for already removed elements (pythonGH-20483)
  closes bpo-29017: Update the bindings for Qt information with PySide2 (pythonGH-20149)
  bpo-39885: Make IDLE context menu cut and copy work again (pythonGH-18951)
  bpo-29882: Add an efficient popcount method for integers (python#771)
  Further de-linting of zoneinfo module (python#20499)
  bpo-40780: Fix failure of _Py_dg_dtoa to remove trailing zeros (pythonGH-20435)
  Indicate that abs() method accept argument that implement __abs__(), just like call() method in the docs (pythonGH-20509)
  bpo-39040: Fix parsing of email mime headers with whitespace between encoded-words. (pythongh-17620)
  bpo-40784: Fix sqlite3 deterministic test (pythonGH-20448)
  bpo-30064: Properly skip unstable loop.sock_connect() racing test (pythonGH-20494)
  Note the output ordering of combinatoric functions (pythonGH-19732)
  bpo-40474: Updated coverage.yml to better report coverage stats (python#19851)
  bpo-40806: Clarify that itertools.product immediately consumes its inpt (pythonGH-20492)
  bpo-1294959: Try to clarify the meaning of platlibdir (pythonGH-20332)
  bpo-37878: PyThreadState_DeleteCurrent() was not removed (pythonGH-20489)
  bpo-40777: Initialize PyDateTime_IsoCalendarDateType.tp_base at run-time (pythonGH-20493)
  bpo-40755: Add missing multiset operations to Counter() (pythonGH-20339)
  bpo-25920: Remove socket.getaddrinfo() lock on macOS (pythonGH-20177)
  bpo-40275: Fix test.support.threading_helper (pythonGH-20488)
  ...
mdickinson
mdickinson reviewed May 31, 2020
View reviewed changes
Doc/library/itertools.rst
@@ -563,6 +563,9 @@ loops that truncate the stream.
for prod in result:
yield tuple(prod)

Before :func:`product` runs, it completely consumes the input iterables,
keeping pools of values in memory to generate the products. Accordingly,
it only useful with finite inputs.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing "is" after "it"?

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

@mdickinson mdickinson mdickinson left review comments

@rhettinger rhettinger rhettinger approved these changes

Assignees

@rhettinger rhettinger

Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@stsouko @the-knights-who-say-ni @rhettinger @miss-islington @bedevere-bot @mdickinson
0