isOverdue documentation in Scheduler is confusing #25223
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
|
Thanks for your pull request! The title of your pull request does not follow our editorial rules. Could you have a look?
|
mkouba
reviewed
Apr 28, 2022
| @@ -31,7 +31,7 @@ public interface Trigger { | |||
| /** | |||
| * The grace period is configurable with {@link Scheduled#overdueGracePeriod()}. | |||
| * <p> | |||
| * This method returns {@code false} if the last execution has been skipped. | |||
| * This method returns {@code false} if the last execution should have been fired but was not. | |||
There was a problem hiding this comment.
We should mention that is wa not fired within the fire time + grace period... I'm not sure about the wording.
There was a problem hiding this comment.
Any chance we could finalize this?
There was a problem hiding this comment.
@mkouba I'm reading this again, and what I wanted to express initially in this message was that If a scheduler execution is skipped, it will not be considered as overdue.
There was a problem hiding this comment.
I think the following is better:
/**
* The grace period is configurable with {@link Scheduled#overdueGracePeriod()}.
* <p>
* Skipped executions are not considered as overdue.
*
* @return {@code false} if the last execution took place between
* the expected execution time and the end of the grace period, {@code true} otherwise
* @see Scheduled#overdueGracePeriod()
*/
This comment has been minimized.
This comment has been minimized.
rmanibus
force-pushed
the
trigger_doc
branch
3 times, most recently
from
ad48918
to
59c58be
Compare
This comment has been minimized.
This comment has been minimized.
mkouba
approved these changes
May 24, 2022
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.
No description provided.