Clarify M-SMALLER-CRATES is mostly orthogonal to whether users should see the smaller crates.
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation
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.
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).
- Dominant language
- Rust
- Stars
- 206
- Forks
- 25
- Avg merge
- 6d 13h
- Merged PRs (30d)
- 3
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from microsoft/rust-guidelines
-
Remove "*.png"Openissue
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
microsoft/rust-guidelines#52 · 1 comment ·
-
request
Difficulty 4/5 3-5 days Newbie friendliness 35/100
microsoft/rust-guidelines#63 ·
-
easy-pr request
Difficulty 4/5 3-5 days Newbie friendliness 35/100
microsoft/rust-guidelines#60 ·
-
issue
Difficulty 5/5 Over a week Newbie friendliness 30/100
microsoft/rust-guidelines#56 ·
-
easy-pr request
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
microsoft/rust-guidelines#51 ·
All issues in microsoft/rust-guidelines
Similar issues
-
area/cli parity
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day
-
A-Picking A-UI C-Bug D-Trivial S-Ready-For-Implementation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
bevyengine/bevy#26029 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
ai_p3 comp-protocols
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
ClickHouse/ClickHouse#123884 ·
Maintainers usually reply within 1 day
-
state:needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
zed-industries/zed#65146 ·
Maintainers usually reply within 1 day