Fix confusing Javadoc of memoizeWithExpiration #5812
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
The previous wording could be read such that the cache is cleared in the background once the expiration time is reached. However this is not the case, so we simply remove the following part of the Javadoc: "and removes the cached value after the specified time has passed" The rest of the Javadoc already accurately describes the behavior, though the part with "After the expiration time" could again be misinterpreted, so we rewrite this to clarify that things only happen once the "get" method is called.
|
Sure, submitted my Contributor License Agreement a minute ago. |
|
It says I should request a rescan regarding CLA from a repository manager. I assume the person who does the releases is for sure one of the a repository managers, so that would be @cpovirk. |
|
This is indeed a common cause of confusion. It would still be good for the first sentence to say something about the expiration. Maybe use the original phrasing but with "removes" changed to "invalidates?" But even that may be misleading, given that |
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.
The previous wording could be read such that the cache is cleared in
the background once the expiration time is reached. However this is
not the case, so we simply remove the following part of the Javadoc:
"and removes the cached value after the specified time has passed"
The rest of the Javadoc already accurately describes the behavior,
though the part with "After the expiration time" could again be
misinterpreted, so we rewrite this to clarify that things only
happen once the "get" method is called.