rust-lang / rust-lang/rustc-dev-guide
add section about how rustdoc uses static analysis
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
inspired by https://github.com/rust-lang/rustc-dev-guide/pull/2298#discussion_r2121786725 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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no file or test; start by locating the existing rustdoc contribution guidance and read the linked rustc-dev-guide discussion. Document how rustdoc uses eslint, tsc, and universal tidy checks in a separate section, including how contributors use them; it is done when these workflows are explained separately from unrelated guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, rust, typescript
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100