Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add module documentation for rustdoc passes #91987

Merged
merged 1 commit into from
Dec 17, 2021
Merged

Conversation

jsha
Copy link
Contributor

@jsha jsha commented Dec 16, 2021

These are currently documented at https://rustc-dev-guide.rust-lang.org/rustdoc-internals.html#hot-potato but can easily go out of date. We'd like to document them in place and link to https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc/passes/index.html

Discussed on Zulip.

r? @camelid

@rustbot rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Dec 16, 2021
@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 16, 2021
@jyn514 jyn514 self-assigned this Dec 16, 2021
Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good idea :) I also think it makes sense to remove the docs from the dev-guide and say to look at the generated docs, to avoid having to maintain them in multiple places.

src/librustdoc/passes/collect_trait_impls.rs Outdated Show resolved Hide resolved
src/librustdoc/passes/propagate_doc_cfg.rs Outdated Show resolved Hide resolved
src/librustdoc/passes/strip_priv_imports.rs Outdated Show resolved Hide resolved
src/librustdoc/passes/stripper.rs Outdated Show resolved Hide resolved
@jyn514
Copy link
Member

jyn514 commented Dec 16, 2021

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Dec 16, 2021

📌 Commit 1d10e1a has been approved by jyn514

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 16, 2021
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 16, 2021
…askrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#91172 (Warn when a `#[test]`-like built-in attribute macro is present multiple times.)
 - rust-lang#91796 (Fix since attribute for const_manually_drop feature)
 - rust-lang#91879 (Remove `in_band_lifetimes` from `rustc_borrowck`)
 - rust-lang#91947 (Add `io::Error::other`)
 - rust-lang#91967 (Pull in libdevstat on FreeBSD)
 - rust-lang#91987 (Add module documentation for rustdoc passes)
 - rust-lang#92001 (Fix default_method_body_is_const when used across crates)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 176fb18 into rust-lang:master Dec 17, 2021
@rustbot rustbot added this to the 1.59.0 milestone Dec 17, 2021
Comment on lines +8 to +11
//! /// A list:
//! ///
//! /// - Foo
//! /// - Bar
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI I think this will render weirdly in the API docs.

@jsha jsha deleted the docdocgoose branch December 17, 2021 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants