Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typo Update index.d.ts #7227

Closed
wants to merge 1 commit into from
Closed

Typo Update index.d.ts #7227

wants to merge 1 commit into from

Conversation

mdqst
Copy link

@mdqst mdqst commented Nov 16, 2024

Description:

This PR addresses an issue in the comments where the word "detail" was incorrectly used. The correct term should be "detailed" when referring to test cases, as it better describes the nature of the test case being suggested.

Changes:

  • Updated comments to replace "detail" with "detailed" in the following sections of the code:
    • In the toBeWithMessage matcher comment.
    • In the toEqualWithMessage matcher comment.

Reason for Change:

The use of "detail" in this context was grammatically incorrect. The appropriate term is "detailed," which is used to describe test cases that are more thorough and precise. This change ensures better clarity and correctness in the code documentation, improving readability and professionalism.

Example:

// Original comment:
// "We highly recommend to not use this matcher instead use detail test case"

// Corrected comment:
"We highly recommend **not** to use this matcher. Instead, use a **detailed** test case."

Impact:

  • Improves the clarity and accuracy of the comments in the code.
  • Enhances the documentation for future developers to understand the purpose of the matcher better.

Fix: Correct "detail" to "detailed" in comments for clarity
@mdqst mdqst requested a review from a team as a code owner November 16, 2024 12:11
@CLAassistant
Copy link

CLAassistant commented Nov 16, 2024

CLA assistant check
All committers have signed the CLA.

@ensi321
Copy link
Contributor

ensi321 commented Nov 17, 2024

No thanks

@ensi321 ensi321 closed this Nov 17, 2024
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.

3 participants