Fix javadoc for internal/Utils.java

[vlad8x8]

Fixes # .

Did you remember to?

• Add test case(s)
• Update CHANGES.txt
• Auto applied styling via ./gradlew autostyleApply

We encourage pull requests that:

• Add new features to TestNG (or)
• Fix bugs in TestNG

If your pull request involves fixing SonarQube issues then we would suggest that you please discuss this with the
TestNG-dev before you spend time working on it.

Note: For more information on contribution guidelines please make sure you refer our Contributing section for detailed set of steps.

Summary by CodeRabbit

• Bug Fixes

  • Corrected functionality for longStackTrace and shortStackTrace methods to ensure proper stack trace formatting.

• Documentation

  • Clarified the behavior of the name attribute in the @Test annotation for more accurate usage.

[coderabbitai]

Walkthrough

The updates involve changes at both the method and documentation levels within the TestNG project. The functionality of the longStackTrace and shortStackTrace methods in Utils.java has been swapped to provide accurate stack trace representations. Additionally, the documentation for the name attribute in the @Test annotation in Test.java has been clarified regarding its behavior when @Test is used at different levels.

Changes

File	Change Summary
.../internal/Utils.java	Swapped functionality of the longStackTrace and shortStackTrace methods to correctly reflect their names.
.../annotations/Test.java	Improved documentation for the name attribute in the @Test annotation to clarify its behavior based on usage level.

Poem

In the code of testing land,
Swapped tracks to understand,
Long and short, they found their way,
Like night and dawn, at break of day.
With docs now clear, no wrongs to right,
TestNG shines a bit more bright.
🐇✨

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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)

testng-core-api/src/main/java/org/testng/internal/Utils.java (2)

Line range hint 314-318:
Ensure Javadoc matches the method functionality.

The Javadoc states that the method returns a short stack trace, but the method is now intended to return a long stack trace.

-  * Helper that returns a short stack trace.
+  * Helper that returns a long stack trace.

---

Line range hint 325-329:
Ensure Javadoc matches the method functionality.

The Javadoc states that the method returns a long stack trace, but the method is now intended to return a short stack trace.

-  * Helper that returns a long stack trace.
+  * Helper that returns a short stack trace.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0f779fe and a9b68b6.

Files selected for processing (1)

• testng-core-api/src/main/java/org/testng/internal/Utils.java (2 hunks)

Additional comments not posted (2)

testng-core-api/src/main/java/org/testng/internal/Utils.java (2)

Line range hint 314-319:
LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to longStackTrace match the new functionality.

---

Line range hint 325-330:
LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to shortStackTrace match the new functionality.

[krmahadevan]

There are formatting issues because of which CI failed.

From the terminal/command prompt please run ./gradlew autostyleApply to fix the formatting discrepancies, amend your commit, force push the changes and please let us know.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a9b68b6 and b8fe3ff.

Files selected for processing (1)

• testng-core-api/src/main/java/org/testng/annotations/Test.java (1 hunks)

Files skipped from review due to trivial changes (1)

• testng-core-api/src/main/java/org/testng/annotations/Test.java

[vlad8x8]

Holly guacamole! I just wanted a quick fix via web UI.
Ok, I pulled this repo and fixed somebodyelses file

[krmahadevan]

@vlad8x8 - Thank you for taking the time to help raise this PR.