Improve scaladocs of eventually

[donce]

Few improvements/fixes:

• "retried at least 40 times" - that's incorrect, it's retried "up to 40 times", not at least
• did not find what's the default sleep of eventually():
  • matchers guide does not say it: https://etorreborre.github.io/specs2/guide/SPECS2-5.5.8/org.specs2.guide.Matchers.html
  • these scaladocs don't mention it either (https://etorreborre.github.io/specs2/api/SPECS2-5.5.8/org/specs2/execute/EventuallyResults.html#eventually-80a)
  • My IDE (IntelliJ) didn't show code to find the default
• made docs more consistent - it's essentially the same method with default values, but different terms are used, which makes reading docs harder than it has to

So, to understand the default, I went through many steps and ended up having to find the implementation in the GitHub 😅

Summary by CodeRabbit

• Documentation
  • Improved documentation for the eventually methods, clarifying their purpose and behavior.
  • Updated comments to specify the retry mechanism and sleep parameters for better user understanding.

[coderabbitai]

Walkthrough

The changes made to the EventuallyResults trait in the org.specs2.execute package focus on enhancing the documentation for its methods. The core functionality of the methods remains unchanged. The eventually methods have updated comments that clarify their behavior, particularly regarding the sleep parameter and the retry mechanism. These modifications aim to provide clearer guidance on how the methods operate, especially for users relying on the documentation for implementation.

Changes

File Path	Change Summary
common/shared/src/main/scala/org/specs2/execute/EventuallyResults.scala	Updated documentation for the eventually methods to clarify behavior without changing functionality.

Poem

In the realm of code where bunnies hop,
Documentation shines, it never will stop.
With retries and sleeps, clarity's the key,
Hopping through logic, as happy as can be!
So let’s celebrate with a joyful cheer,
For clearer code brings us all near! 🐇✨

Warning

Tool Failures:

Tool Failure Count:

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

common/shared/src/main/scala/org/specs2/execute/EventuallyResults.scala (2)

43-43: Enhance documentation clarity for consistency.

The return documentation could be more specific about the behavior, matching the detail level of other methods.

-   *   a matcher that will retry the nested matcher a given number of times with a given duration of sleep in between
+   *   a matcher that will retry the nested matcher up to the specified number of times, with a fixed sleep duration between attempts

---

43-50: Consider standardizing documentation terminology across methods.

While the documentation is accurate, consider using consistent terminology across all eventually method variants. For example, standardize the use of terms like "matcher" and "retry" in all method documentation.

Suggested pattern for all methods:

/** @return
  *   retries the nested matcher up to [X] times, with [Y] sleep duration between attempts
  */

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between dc6b809 and a4f63aa.

📒 Files selected for processing (1)

• common/shared/src/main/scala/org/specs2/execute/EventuallyResults.scala (1 hunks)

🔇 Additional comments (1)

common/shared/src/main/scala/org/specs2/execute/EventuallyResults.scala (1)

48-50: Documentation improvements align perfectly with PR objectives.

The updated documentation successfully addresses both key objectives:

1. Clarifies the retry behavior
2. Explicitly states the default sleep duration (100ms)

This change significantly improves clarity for users, especially those relying on IDE documentation.

[etorreborre]

Excellent, thank you @donce!