M-DOC-INLINE is too broad

Open
#5 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
rust
Domain
documentation

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.

Description

issue

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?

Dominant language
Rust
Stars
200
Forks
25
Avg merge
3m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/rust-guidelines

All issues in microsoft/rust-guidelines

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.