Skip to content

add section about how rustdoc uses static analysis #2449

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

Jump to bottom
Open
lolbinarycat opened this issue Jun 2, 2025 · 1 comment
Open

add section about how rustdoc uses static analysis #2449

lolbinarycat opened this issue Jun 2, 2025 · 1 comment
Labels
C-enhancement Category: enhancement T-rustdoc Relevant to rustdoc team

Comments

@lolbinarycat
Copy link
Contributor

inspired by #2298 (comment) and my own confusion with eslint

rustdoc currently uses two tools for linting, eslint and tsc (as well as universal tidy checks, like line length), and we don't currently explain how to use them in much detail, it would be nice to have a separate section for this, instead of mixing this info in with other stuff.
@rustbot rustbot added the needs-triage This issue needs triage to classify its nature and status label Jun 2, 2025
@fmease fmease added T-rustdoc Relevant to rustdoc team C-enhancement Category: enhancement and removed needs-triage This issue needs triage to classify its nature and status labels Jun 2, 2025
@lolbinarycat
Copy link
Contributor Author

es-check is another static analysis tool we use.

I think "run all the rustdoc static analysis stuff" should be split into a separate "testsuite" under bootstrap, instead of just grouping it under ./x test tidy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-enhancement Category: enhancement T-rustdoc Relevant to rustdoc team
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@fmease @lolbinarycat @rustbot