Clarify ngx.timer.every callback argument conventions #1409
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.
I hereby grant the copyright of the changes in this pull request
to the authors of this lua-nginx-module project.
We recently implemented a new
ngx.timer.everytimer in our codebase and didn't realize that the calling conventions ofngx.timer.every's callback also include theprematureargument. When we were implementing the feature, we actually interpreted the docs such that we thoughtprematurewas only used forattimers.Here's a quick clarification to those docs to make clear that the way the
callbackis called is the same as forngx.timer.at.