-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Add module documentation for rustdoc passes #91987
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Conversation
There was a problem hiding this 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.
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
@bors r+ rollup |
📌 Commit 1d10e1a has been approved by |
…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
//! /// A list: | ||
//! /// | ||
//! /// - Foo | ||
//! /// - Bar |
There was a problem hiding this comment.
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.
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