-
Notifications
You must be signed in to change notification settings - Fork 6k
Closed
Labels
ℹ️ good-first-issueinformation: good-first-issueinformation: good-first-issue🛠 breakingchange type: breakingchange type: breaking🛠 refactorchange type: refactorchange type: refactor
Milestone
Description
Current situation
The naming of Job.context regularly leads to confusion, because the context parameter of job/error/handler callbacks has the same name. Accessing that value in a job callback as context.job.context can be even more confusing.
Proposed solution
Rename Job.context to Job.data and correspondingly also rename the context argument of JobQueue.run_* to data.
ToDo
A PR for this should
- rename the parameters of the
JobQueuemethods and the attribute of theJobclass - update the docstrings accordingly
- add
.. versionchanged:: 20.0directives to the documentation - Update the unit tests accordingly. Letting the test suit run once to see which tests fail after the update should probably already find most tests that need adaption.
- Check if the
timerbot.pyexample needs to be updated.
Additional Info
We have a contribution guide
Metadata
Metadata
Assignees
Labels
ℹ️ good-first-issueinformation: good-first-issueinformation: good-first-issue🛠 breakingchange type: breakingchange type: breaking🛠 refactorchange type: refactorchange type: refactor