GH-4963: Clarify Javadoc for FaultTolerantStepBuilder#skipLimit #4967
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.
Fixes #4963
Summary
The current Javadoc for the
FaultTolerantStepBuilder#skipLimit
method is misleading. It states that the skip limit is "ignored" when a customSkipPolicy
is provided, which can be misinterpreted by users to mean that the value is always irrelevant in such cases.Solution
This pull request improves the Javadocs for both
skipLimit()
and the relatedskipPolicy()
method to make their relationship and behavior crystal clear.Based on valuable community feedback, the updated documentation now provides better context on default behavior and clarifies how setting a custom policy overrides the default settings.
Key Changes
In
skipLimit()
:LimitCheckingItemSkipPolicy
and the default limit value of 10.In
skipPolicy()
:skipLimit()
.The copyright year in the license header has been updated as per the contributor guidelines.
Adding a
@see
tag that links to theSkipPolicy
interface for better context and navigation.