rust-lang / rust-lang/rustc-dev-guide
Typo in docs
Open
Beginner friendly
Nobody has claimed this yet.
needs-triage
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
On the Rustdoc internals page there is a half finished sentence in the first section.
- handling import globs and cycles, so there are no duplicates or infinite directory trees
- inlining public use exports of private items, or showing a “Reexport” line in the module page
- inlining items with
#[doc(hidden)]if the base item is hidden but the- showing
#[macro_export]-ed macros at the crate root, regardless of whether they’re defined as a reexport or not
Contributor guide
No contributing guide indexed for this repository
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
Open the linked Rustdoc internals page and inspect the first section, especially the quoted bullet beginning “inlining items with #[doc(hidden)]”. Correct the half-finished sentence while preserving the surrounding list, then verify that the rendered documentation reads coherently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 82/100