Skip to content

Fix typos on suiteName and testName attributes#3137

Merged
juherr merged 1 commit intotestng-team:masterfrom
Philzen:patch-1
Jun 14, 2024
Merged

Fix typos on suiteName and testName attributes#3137
juherr merged 1 commit intotestng-team:masterfrom
Philzen:patch-1

Conversation

@Philzen
Copy link
Copy Markdown
Contributor

@Philzen Philzen commented Jun 14, 2024 •
edited by coderabbitai bot
Loading

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

  • Documentation
    • Corrected typos in documentation comments for suiteName() and testName() methods to improve clarity.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jun 14, 2024 •
edited
Loading

Walkthrough

This update addresses documentation clarity in the Test.java file within the testng-core-api module by correcting typos. Specifically, the word "ignore" was appropriately changed to "ignored" in the documentation comments for the suiteName() and testName() methods. This enhances the documentation readability and correctly communicates the intended usage of these methods.

Changes

File Change Summary
testng-core-api/src/main/java/org/testng/annotations/Test.java Corrected typos in documentation comments, changing "ignore" to "ignored" for suiteName() and testName() methods.

Poem

🐇
In the land of code, where bugs may hide,
Small tweaks in docs help us ride.
"Ignored," we now clearly say,
Making sense in a coder's way.
A tiny change, a clearer tide,
Ensuring smooth flows far and wide.
🚀✨

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
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[bot]
coderabbitai bot reviewed Jun 14, 2024
View reviewed changes
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 e0a7d5f and 4446295.

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

@juherr juherr merged commit 0f779fe into testng-team:master Jun 14, 2024
@Philzen Philzen deleted the patch-1 branch June 15, 2024 23:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@juherr juherr juherr approved these changes

@krmahadevan krmahadevan Awaiting requested review from krmahadevan krmahadevan is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Philzen @juherr