-
Notifications
You must be signed in to change notification settings - Fork 22
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
feat(run): deprecate parameters in run function that are in context #483
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder whether the documentation should stay in the run section? If not, paragraph will need to be reworded to precise that it concerns the process execution through the run()
helper.
LGTM otherwise
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM too 👍🏼 same question as @pyrech
8ad1320
to
9dda382
Compare
I was wondering the same about context, but since context may be used in other place that the run method, i think it's better to have documentation about it in the context section and not the run section, even if somes parameters are linked to the run function, they may be used when another method will use the So for me documentation about those parameters should be in context section not in the run one, maybe we could add some links inside the run documentation to help this |
9dda382
to
31f18e2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Could you rebase + add a note in the CHANGELOG? |
31f18e2
to
8c2faf2
Compare
done |
Goal is each parameters that is available in context should not be duplicated in the run function (or function depending on it), should simplify calls in the futures