Rename RunImmediately to RunOnStart
#8
Merged
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
|
@bgentry Thoughts on this one? |
bgentry
approved these changes
Nov 11, 2023
brandur
force-pushed
the
brandur-run-on-start
branch
from
f62853c
to
20c1b54
Compare
This is another bikeshed issue, but I was thinking about the naming of `RunImmediately` today and I think it might be too ambiguous. It sounds a little too much like it could mean "run immediately when scheduled". I propose we rename it to `RunOnStart` to make it clear that it's expected to run on the scheduler's start (this is also said in the property's docblock). `RunOnStart` is also a little more succinct which is always nice. The repository is technically public now and this is technically a breaking change, but I think it's fair for us to make a few API tweaks in the early days before we've done anything to send the project around (and maybe even a little after). This property in mentioned in our public docs already [1]. If this gets merged I'll follow up by updating it there as well. [1] https://riverqueue.com/docs/periodic-jobs
brandur
force-pushed
the
brandur-run-on-start
branch
from
20c1b54
to
43b2e3a
Compare
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.
This is another bikeshed issue, but I was thinking about the naming of
RunImmediatelytoday and I think it might be too ambiguous. It soundsa little too much like it could mean "run immediately when scheduled".
I propose we rename it to
RunOnStartto make it clear that it'sexpected to run on the scheduler's start (this is also said in the
property's docblock).
RunOnStartis also a little more succinct whichis always nice.
The repository is technically public now and this is technically a
breaking change, but I think it's fair for us to make a few API tweaks
in the early days before we've done anything to send the project around
(and maybe even a little after).
This property in mentioned in our public docs already [1]. If this gets
merged I'll follow up by updating it there as well.
[1] https://riverqueue.com/docs/periodic-jobs