2.x: Expand the JavaDocs of the Scheduler API #5843
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
Codecov Report
@@ Coverage Diff @@
## 2.x #5843 +/- ##
============================================
- Coverage 96.38% 96.37% -0.01%
- Complexity 5812 5814 +2
============================================
Files 634 634
Lines 41760 41760
Branches 5796 5796
============================================
- Hits 40251 40248 -3
+ Misses 591 588 -3
- Partials 918 924 +6
Continue to review full report at Codecov.
|
vanniktech
approved these changes
Feb 8, 2018
artem-zinnatullin
approved these changes
Feb 12, 2018
| * units of work with or without delays or periodically. | ||
| * You can get common instances of this class in {@link io.reactivex.schedulers.Schedulers}. | ||
| * units of work provided in the form of {@link Runnable}s to be | ||
| * executed immediately, after a specified time delay or periodically |
There was a problem hiding this comment.
nit: maybe replace immediately with something like "as soon as possible"?
| * the {@link Worker#schedule(Runnable, long, TimeUnit)} for scheduling the {@code Runnable} task periodically. | ||
| * The algorithm calculates the next absolute time when the task should run again and schedules this execution | ||
| * based on the relative time between it and {@link Worker#now(TimeUnit)}. However, drifts or changes in the | ||
| * system clock would affect this calculation either by scheduling subsequent runs too frequently or too far apart. |
| * Schedules a cancelable action to be executed periodically. This default implementation schedules | ||
| * recursively and waits for actions to complete (instead of potentially executing long-running actions | ||
| * concurrently). Each scheduler that can do periodic scheduling in a better way should override this. | ||
| * Schedules a cancelable action to be executed periodically. |
There was a problem hiding this comment.
Maybe remove "cancelable" or add it to other "scheduleXXX" methods?
Other "scheduleXXX" methods also allow cancellation, but their javadoc only mentions it in the description of returned Disposable
vanniktech
approved these changes
Feb 12, 2018
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 PR adds more details to the
SchedulerandWorkerAPI, rewords some older sentences and fixes a few mistakes in others.In addition, the wording of the
SchedulerRunnableIntrospectionfelt a bit clumsy and has been updated as well.