-
Notifications
You must be signed in to change notification settings - Fork 12.7k
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
Update rustdoc documentation #82690
Update rustdoc documentation #82690
Conversation
@@ -340,6 +340,30 @@ Some methodology notes about what rustdoc counts in this metric: | |||
Public items that are not documented can be seen with the built-in `missing_docs` lint. Private | |||
items that are not documented can be seen with Clippy's `missing_docs_in_private_items` lint. | |||
|
|||
## `-w`/`--output-format`: output format |
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 isn't strictly an unstable option, but it's useless except on nightly, so I moved it here.
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.
lgtm
we should really just get rid of passes.md, but i'm fine with a stub so links don't break. Would be nice if it could be hidden from the toc.
Good idea, done :) @bors r=Manishearth rollup |
📌 Commit a762374e4e571b1cefd3ddca06c12adc3c90df56 has been approved by |
This comment has been minimized.
This comment has been minimized.
@bors r- Apparently removing it from the table of the contents causes it not to get built (??) |
} | ||
``` | ||
|
||
`--document-private-items` documents all items, even if they're not public. |
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.
Maybe a note on the fact it is very useful when developing the library or binary crate that is being documented, not as a user of said library/binary ? I don't know if that's a good place to put such a tip
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.
Hmm, does that need explanation? It seems pretty self-evident to me.
This comment has been minimized.
This comment has been minimized.
- Remove most of the information about passes. Passes are deprecated. - Add `--document-private-items`; it was missing before. - Update `--output-format json`; it was very outdated. - Note that `--input-format` is deprecated. - Move deprecated options to the very end. - Move `passes.html` to the end of the table of contents. Ideally it would be removed altogether, but that causes mdbook not to generate the docs.
I added it back for now (at the very end, so you don't see it in the middle of reading the book). @poliorcetics I haven't forgotten your comment, but I think it can be addressed in a follow-up if need be. @bors r=Manishearth rollup |
📌 Commit dbdaa12 has been approved by |
Update rustdoc documentation - Remove most of the information about passes. Passes are deprecated. - Add `--document-private-items`; it was missing before. - Update `--output-format json`; it was very outdated. - Note that `--input-format` is deprecated. - Move deprecated options to the very end. Closes rust-lang#82675. r? ``@Manishearth``
Update rustdoc documentation - Remove most of the information about passes. Passes are deprecated. - Add `--document-private-items`; it was missing before. - Update `--output-format json`; it was very outdated. - Note that `--input-format` is deprecated. - Move deprecated options to the very end. Closes rust-lang#82675. r? ```@Manishearth```
…laumeGomez Rollup of 5 pull requests Successful merges: - rust-lang#76716 (Don't warn for `missing_doc_examples` when item is #[doc(hidden)]) - rust-lang#82088 (Shorten html::render) - rust-lang#82690 (Update rustdoc documentation) - rust-lang#82752 (Add a regression test for issue-81712) - rust-lang#82765 (Fix polymorphization ICE on associated types in trait decls using const generics in bounds) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Update rustdoc documentation - Remove most of the information about passes. Passes are deprecated. - Add `--document-private-items`; it was missing before. - Update `--output-format json`; it was very outdated. - Note that `--input-format` is deprecated. - Move deprecated options to the very end. Closes rust-lang#82675. r? ````@Manishearth````
--document-private-items
; it was missing before.--output-format json
; it was very outdated.--input-format
is deprecated.Closes #82675.
r? @Manishearth