rust-lang / rust-lang/std-dev-guide
Document when to use #[rustc_inherit_overflow_checks]
Open
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 90
- Forks
- 47
- Avg merge
- 9h 22m
- Merged PRs (30d)
- 1
Description
We're using Add:add(..) explicitly in a few places that should probably just use #[rustc_inherit_overflow_checks] instead.
We should document how the attribute works and when to use it.
(cc @eddyb)
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
No file or test is named. Start by locating the existing uses of Add::add(..) and #[rustc_inherit_overflow_checks], then inspect how the attribute behaves in those contexts. Done means documenting what the attribute does and when it should be used instead of an explicit Add::add(..) call.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100