microsoft / microsoft/rust-guidelines

Clarify M-SMALLER-CRATES is mostly orthogonal to whether users should see the smaller crates.

Open
#22 0 comments 0 reactions 0 assignees View on GitHub
issue
Dominant language
Rust
Stars
200
Forks
25
Avg merge
3m
Merged PRs (30d)
1

Description

... in other words, it's perfectly normal in rust to have `foo` re-exporting `foo_x` and `foo_y` as an umbrella, and rightfully expecting that users will not deal with `foo_x` and `foo_y` directly (and if they do and run into issues, e.g., around macros) it's just a not supported use case).

Contributor guide

Open the contributing guide

Research direction

Locate the guideline section discussing M-SMALLER-CRATES and read its surrounding guidance on crate visibility and re-exports. Clarify that the guideline is independent of whether users should interact with smaller crates, while preserving the umbrella-crate example. Done when the resulting wording states this distinction unambiguously; no test is mentioned.

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
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.