rust-lang / rust-lang/rustc-dev-guide
explain how rustdoc uses eslint
Open
Nobody has claimed this yet.
A-test-suite
C-enhancement
T-rustdoc
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
as far as i can tell, rustdoc's usage of eslint and tsc exist outside of compiletest, and are instead explicitly called in CI.
this can be kinda confusing, especially if a PR passes all tests, but fails at CI.
i think this should be documented right next to the part where it says that tsc is used
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
Start at the rustdoc guide's Tests section, where the existing tsc note is linked. Document that rustdoc's eslint and tsc checks are invoked explicitly in CI rather than through compiletest, so contributors know why a PR can pass tests but fail CI.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, rust, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100