Skip to content

Conversation

rla124
Copy link

@rla124 rla124 commented Sep 4, 2025

Fixes #4963

Summary

The current Javadoc for the FaultTolerantStepBuilder#skipLimit method is misleading. It states that the skip limit is "ignored" when a custom SkipPolicy 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 related skipPolicy() 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():

    • The description has been reworded to remove the ambiguous term "ignored".
    • Details about the default behavior have been added, explicitly mentioning the LimitCheckingItemSkipPolicy and the default limit value of 10.
  • In skipPolicy():

    • A new note has been added to its Javadoc, providing a clear cross-reference that it overrides the behavior configured via skipLimit().
  • The copyright year in the license header has been updated as per the contributor guidelines.

  • Adding a @see tag that links to the SkipPolicy interface for better context and navigation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: FaultTolerantStepBuilder#skipLimit Javadoc is misleading with custom skipPolicy
1 participant