Polish Mono cache operators documentation #2790
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
This commit polishes the javadoc of most cache variants in Mono: - explicit the behavior in case of concurrent subscriptions for `cache()`, `cache(Duration)` and `cache(Function)` - polish (un)ordered lists and paragraph breaks in `cacheInvalidateIf` and `cacheInvalidateWhen` javadoc. Fixes #2782.
|
cc @jzheaux for |
OlegDokuka
approved these changes
Sep 24, 2021
Comment on lines
1822
to
1827
| * Cache loading (ie. subscription to the source) can happen either at the very | ||
| * first subscription or after the cache has been cleared due to expiry. | ||
| * Once that upstream subscription is started, it cannot be cancelled. | ||
| * The operator will however prevent multiple concurrent subscriptions from triggering | ||
| * duplicated loading (only one load-triggering subscription can win at a time, | ||
| * and the others will get notified of the newly cached value when it arrives). |
There was a problem hiding this comment.
How about the following:
Suggested change
| * Cache loading (ie. subscription to the source) can happen either at the very | |
| * first subscription or after the cache has been cleared due to expiry. | |
| * Once that upstream subscription is started, it cannot be cancelled. | |
| * The operator will however prevent multiple concurrent subscriptions from triggering | |
| * duplicated loading (only one load-triggering subscription can win at a time, | |
| * and the others will get notified of the newly cached value when it arrives). | |
| * Cache loading (ie. subscription to the source) is triggered by the very | |
| * first subscription to empty or expired cache. | |
| * Once the cache loading is started, it cannot be cancelled. | |
| * The operator guarantees that only a single cash loading may happen at a time | |
| * (only one load-triggering subscription can win at a time, | |
| * and the others will get notified of the newly cached value when it arrives). |
There was a problem hiding this comment.
same should be applied to the following similar changes if makes sence
There was a problem hiding this comment.
good suggestion. I actually took inspiration and reworded and simplified these sections even further in the last commit, let me know what you think
|
@simonbasle Perfecto 👌. |
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 commit polishes the javadoc of most cache variants in Mono:
cache(),cache(Duration)andcache(Function)cacheInvalidateIfand
cacheInvalidateWhenjavadoc.Fixes #2782.