rust-lang / rust-lang/reference

Confusing reference to “items” in “Visibility and Privacy”

Open
#1,503 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-visibility
Dominant language
Rust
Stars
1.6k
Forks
607
PR merge metrics
PR metrics pending

Description

The 12.6. Visibility and Privacy section has the following text: “The items are one of those mentioned above, but also include external crates.” It is unclear which items are meant, I don’t see anything relevant (or much at all) above in that section. Perhaps the list has gone into some other section?

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.

Research direction

Read the “12.6. Visibility and Privacy” section at the linked Reference page, focusing on the sentence referring to “items” and the material immediately above it. Determine which items the sentence means, then clarify or update the wording so the reference is unambiguous; done when readers can identify the items without guessing.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.