Fix documentation for 2nd Batch callback parameter: consistently call it context
#1476
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you for pointing out this inconsistency; the docs are all over the place. I think this variable should probably be called "context" because it's about the context in which the callback job was enqueued. Currently it only has 1 key (event). |
bensheldon
changed the title
options => params in README.mdcontext
|
Nice! Didn’t get around to it, thanks for fixing! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
optionsandparamsare both being used to refer to the second argument passed to the#performmethod of a callback job. I pickedparams, but I'm fine with both as long as the naming is consistent.