Document private items for Cargo and publish under contributor guide #11019
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
r? @epage (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
FYI, private items got a lock emoji (🔒), so existing readers should know an item is public or private with little efforts.
|
epage
reviewed
Aug 24, 2022
weihanglo
force-pushed
the
doc-private-items-cargo-itself
branch
from
93b0977
to
1c82d9c
Compare
weihanglo
changed the title
|
@bors r+ |
bors
added
S-waiting-on-bors
|
☀️ Test successful - checks-actions |
weihanglo
added a commit
to rust-lang/rust
that referenced
this pull request
Sep 5, 2022
8 commits in 4ed54cecce3ce9ab6ff058781f4c8a500ee6b8b5..646e9a0b9ea8354cc409d05f10e8dc752c5de78e 2022-08-27 18:41:39 +0000 to 2022-09-02 14:29:28 +0000 - Support inheriting jobserver fd for external subcommands (rust-lang/cargo#10511) - refactor(cli): Lazy load config (rust-lang/cargo#11029) - chore: Don't show genned docs in ripgrep (rust-lang/cargo#11040) - Document private items for Cargo and publish under contributor guide (rust-lang/cargo#11019) - Add names to CI jobs (rust-lang/cargo#11039) - Rework test error handling (rust-lang/cargo#11028) - Very slight `cargo add` documentation improvements (rust-lang/cargo#11033) - Update compiling requirements. (rust-lang/cargo#11030)
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Sep 5, 2022
Update cargo 8 commits in 4ed54cecce3ce9ab6ff058781f4c8a500ee6b8b5..646e9a0b9ea8354cc409d05f10e8dc752c5de78e 2022-08-27 18:41:39 +0000 to 2022-09-02 14:29:28 +0000 - Support inheriting jobserver fd for external subcommands (rust-lang/cargo#10511) - refactor(cli): Lazy load config (rust-lang/cargo#11029) - chore: Don't show genned docs in ripgrep (rust-lang/cargo#11040) - Document private items for Cargo and publish under contributor guide (rust-lang/cargo#11019) - Add names to CI jobs (rust-lang/cargo#11039) - Rework test error handling (rust-lang/cargo#11028) - Very slight `cargo add` documentation improvements (rust-lang/cargo#11033) - Update compiling requirements. (rust-lang/cargo#11030)
bors
added a commit
that referenced
this pull request
Sep 9, 2022
chore(ci): Ensure intradoc links are valid The plan is to move the architecture documents over to rustdoc so they can more easily stay up-to-date. To do so, we'll need to enforce that the intradoc links stay valid. As part of this, the PR run for `cargo doc` was updated to the command in #11019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR try to resolve?
Document private items for Cargo and publish under contributor guide.
Cargo has many high quality doc comments hidden in its private universe. Making them public benefits both external tools developers and Cargo developers. Having a public doc also means they are under public scrutiny. We could expect more fixes against private docs. It is also more friendly to read for some people, at least I found myself often run
cargo doc --document-private-items --no-depsif my eyes are tired of black-white terminals.Anyway, a more discoverable documentation for Cargo internals is not a bad thing.
The site would eventually sit on https://doc.crates.io/contrib/apidoc/cargo.
How should we test and review this PR?
A demo site also temporarily lives on https://weihanglo.tw/cargo/contrib/apidoc/cargo/
Additional information
Most of the docs are written by ehuss and alexcrichton. Highly appreciate their works. Kudos to them!
For any possible plan on merging Cargo Architecture doc into rustdoc, I don't think it would block this PR or vice versa.