Overhaul Javadoc of RetryTemplateBuilder
#359
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
artembilan
requested changes
Jun 6, 2023
| @@ -497,10 +506,11 @@ public RetryTemplateBuilder withListener(RetryListener listener) { | |||
| } | |||
|
|
|||
| /** | |||
| * Appends all provided {@code listeners} to {@link RetryTemplate}'s listener list. | |||
| * Appends all provided {@code listeners} to {@link RetryTemplate}'s list of | |||
There was a problem hiding this comment.
The method Javadoc must be imperative: https://github.com/spring-projects/spring-framework/wiki/Code-Style#javadoc-formatting
I see that in some place you have it fixed, but not here.
|
Problems should be fixed. As far as I can see, I'm already mentioned as an |
aahlenst
force-pushed
the
new-builder-docs
branch
from
653fbb8
to
d103ba2
Compare
|
thank you for contribution; looking forward for more! |
|
Small correction. This task is not about Noticed "Overhaul Javadoc of RestTemplateBuilder" in v2.0.2 release notes and was very surprised. 😄 |
artembilan
changed the title
RetryTemplateBuilder
|
Fixed. |
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.
While working on
RetryTemplateBuilder, I noticed a couple of typos, some confusing explanations, a lack of descriptions of error conditions, and that it does not always follow the Spring Framework style guide. So I tried my best to improve it.If you're not happy with some choices I made, feel free to edit it yourself.