rust-lang / rust-lang/rust

add std and core to nightly-rustc docs

Open
#130,955 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-discussion C-feature-request
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

the rustc internal api docs differ from the main std docs in two major ways:

  1. documenting different crates
  2. showing private items

being able to see std-internal items would be quite handy for anyone developing the standard library.

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

Compare the nightly-rustc API docs with the main std documentation, focusing on the documented crates and visibility of private items. Trace the documentation-generation entry point in the rust repository and identify how the nightly docs are configured. Done means the nightly-rustc docs include std and core and expose their internal items.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.