rust-lang / rust-lang/std-dev-guide
Update `#[inline]` guidance
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 90
- Forks
- 47
- Avg merge
- 9h 22m
- Merged PRs (30d)
- 1
Description
Our current guidance on using #[inline] should mention profiling as our guiding principle even in places where we currently think the attribute "shouldn't" be needed (and maybe we want to revisit those "shouldn't"s). I think it can be inferred from the docs that making changes to #[inline] can be a separate PR to other changes but we should make that more explicit.
See also https://github.com/rust-lang/rust/pull/109546. cc @saethlin
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 with the current #[inline] guidance at https://std-dev-guide.rust-lang.org/policy/inline.html and review the related Rust pull request, #109546. Update the guidance to make profiling the guiding principle explicit, revisit the stated cases where the attribute should not be needed, and clarify that inline changes can be submitted separately from other changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100