Skip to content

[chai] Fix assorted JSDoc typos #70114

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.

Sign up for GitHub

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

Merged
typescript-bot merged 1 commit into from
Aug 1, 2024
Merged

[chai] Fix assorted JSDoc typos #70114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions types/chai/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -872,7 +872,7 @@ declare namespace Chai {
include<T>(haystack: T, needle: Partial<T>, message?: string): void;

/**
* Asserts that haystack does not includes needle.
* Asserts that haystack does not include needle.
*
* @param haystack Container string.
* @param needle Potential substring of haystack.
Expand All @@ -881,7 +881,7 @@ declare namespace Chai {
notInclude(haystack: string, needle: string, message?: string): void;

/**
* Asserts that haystack does not includes needle.
* Asserts that haystack does not include needle.
*
* T Type of values in haystack.
* @param haystack Container array, set or map.
Expand All @@ -895,7 +895,7 @@ declare namespace Chai {
): void;

/**
* Asserts that haystack does not includes needle.
* Asserts that haystack does not include needle.
*
* T Type of values in haystack.
* @param haystack WeakSet container.
Expand All @@ -905,7 +905,7 @@ declare namespace Chai {
notInclude<T extends object>(haystack: WeakSet<T>, needle: T, message?: string): void;

/**
* Asserts that haystack does not includes needle.
* Asserts that haystack does not include needle.
*
* T Type of haystack.
* @param haystack Object.
Expand Down Expand Up @@ -940,7 +940,7 @@ declare namespace Chai {
): void;

/**
* Asserts that haystack does not includes needle.
* Asserts that haystack does not include needle.
*
* T Type of haystack.
* @param haystack Object.
Expand All @@ -950,7 +950,7 @@ declare namespace Chai {
deepInclude<T>(haystack: T, needle: T extends WeakSet<any> ? never : Partial<T>, message?: string): void;

/**
* Asserts that haystack does not includes needle. Deep equality is used.
* Asserts that haystack does not include needle. Deep equality is used.
*
* @param haystack Container string.
* @param needle Potential substring of haystack.
Expand All @@ -961,7 +961,7 @@ declare namespace Chai {
notDeepInclude(haystack: string, needle: string, message?: string): void;

/**
* Asserts that haystack does not includes needle. Deep equality is used.
* Asserts that haystack does not include needle. Deep equality is used.
*
* T Type of values in haystack.
* @param haystack Container array, set or map.
Expand All @@ -975,7 +975,7 @@ declare namespace Chai {
): void;

/**
* Asserts that haystack does not includes needle. Deep equality is used.
* Asserts that haystack does not include needle. Deep equality is used.
*
* T Type of haystack.
* @param haystack Object.
Expand Down Expand Up @@ -1109,7 +1109,7 @@ declare namespace Chai {
property<T>(object: T, property: string, /* keyof T */ message?: string): void;

/**
* Asserts that object has a property named by property.
* Asserts that object does not have a property named by property.
Copy link
Collaborator Author

@JoshuaKGoldberg JoshuaKGoldberg Jul 21, 2024

Choose a reason for hiding this comment

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

This one is an actual incorrect comment, rather than just typos. I got confused by it writing some Chai tests. 😄

*
* T Type of object.
* @param object Container object.
Expand Down