microsoft / microsoft/rust-guidelines
M-DOC-INLINE is too broad
Open
Nobody has claimed this yet.
issue
- Dominant language
- Rust
- Stars
- 200
- Forks
- 25
- Avg merge
- 3m
- Merged PRs (30d)
- 1
Description
I am not sure what exactly the criteria are but in many cases everything works fine without doc(inline). I am guessing this is only relevant for things that are already public via a different path?
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 locating the M-DOC-INLINE guideline and reviewing its current wording and examples. Compare cases where doc(inline) is used with cases where it is omitted, then document clear criteria for when the annotation is relevant and how the guideline should explain those cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100