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

doc: add example with arguments to `each_iteration #221

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

Conversation

fwolfst
Copy link

@fwolfst fwolfst commented May 13, 2022

fixes #220

@ghost ghost added the cla-needed label May 13, 2022
Copy link
Member

@etiennebarrie etiennebarrie left a comment

Choose a reason for hiding this comment

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

The BatchesJob and BatchesAsRelationJob already pass additional arguments. Your added class doesn't really add much to that. Maybe if we just had an additional sentence before the example that would be more explicit. By the way the CSV example should be fixed because it passes an argument to build_enumerator which is not passed to each_iteration.

)
end

# addtional arguments as in #build_enumerator (except the cursor)
Copy link
Member

Choose a reason for hiding this comment

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

typo here

@fwolfst
Copy link
Author

fwolfst commented Jun 21, 2022

The BatchesJob and BatchesAsRelationJob already pass additional arguments. Your added class doesn't really add much to that. Maybe if we just had an additional sentence before the example that would be more explicit. By the way the CSV example should be fixed because it passes an argument to build_enumerator which is not passed to each_iteration.

Whatever solves #220 . I really find the example and the verbal explanations lacking (for this aspect). Also, my example makes explicit that you might need different stuff to create the enumerator and how to deal with that situation. Should I include the csv and typo-fix and sign the CLA or will this issue not be solved via this PR?

@etiennebarrie
Copy link
Member

Yes sorry I wasn't clear, this is great, adding more explicit verbal explanation right before your added example is a great idea and I will merge this 👍

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

Successfully merging this pull request may close these issues.

document parameters to build_enumerator and each_iteration
2 participants