Skip to content
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.

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

Examples of valid and invalid usage of generator as table container #642

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ewelkaw
Copy link

@ewelkaw ewelkaw commented Mar 6, 2023

This PR has the objective of providing some more examples of valid and invalid usage of generator as table container.

Changes

  1. Improved the docs about usage of generators as data containers

@bmaggard
Copy link
Contributor

bmaggard commented Mar 6, 2023

Please reject this PR. valid_container_generator is not a valid table container.

Other considerations:

  1. batched is something that can be imported from more_itertools, not itertools.
  2. The documentation is already clear about what table containers and table iterators are. ("each subsequent item returned by the iterator is a data row comprising a sequence of data values")
  3. We cannot and should not be documenting all the things table containers/iterators are not,
  4. An example of what is not a table container (csv.reader()) is already provided.
  5. The yielded data_row is actually first a header row, then data rows.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants