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

Docs: Document RuleTester static methods #8274

Open
2 tasks done
JoshuaKGoldberg opened this issue Jan 19, 2024 · 0 comments
Open
2 tasks done

Docs: Document RuleTester static methods #8274

JoshuaKGoldberg opened this issue Jan 19, 2024 · 0 comments
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating enhancement New feature or request

Comments

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented Jan 19, 2024

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

@justinfagnani posted in our Discord some questions about RuleTester errors around describe and afterAll. The thread ended up noting that we don't have a docs section describing what RuleTester's static methods such as describe and it do. I think that'd be useful in an "Other Frameworks" section after Jest, Vitest, etc. That way folks using some arbitrary other framework can understand which statics they need.

Sibling issue to #8273.

Affected URL(s)

https://typescript-eslint.io/packages/rule-tester/#with-specific-frameworks

@JoshuaKGoldberg JoshuaKGoldberg added triage Waiting for maintainers to take a look documentation Documentation ("docs") that needs adding/updating labels Jan 19, 2024
@JoshuaKGoldberg JoshuaKGoldberg added enhancement New feature or request accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for maintainers to take a look labels Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant