Investigate how we can have the CI pipeline complain about warnings in doc code.
Open
Nobody has claimed this yet.
help wanted
priority:nicetohave
- Dominant language
- Rust
- Stars
- 5.6k
- Forks
- 1.3k
- Avg merge
- 8h 47m
- Merged PRs (30d)
- 19
Description
Description
Currently it seems that rustdoc doesn't emit warnings for deprecated variables usage, see https://github.com/libp2p/rust-libp2p/pull/3238#discussion_r1053911469.
We should Investigate if and how can we turn on this (and other like unused variables) warnings for code on doc comments.
Are you planning to do it yourself in a pull request?
Yes if required
Contributor guide
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 by reviewing rustdoc behavior for deprecated and unused variables in code within doc comments, along with the linked pull request discussion. Done means determining whether these warnings can be enabled and documenting or applying the required CI pipeline change.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100