fork/rust

git clone https://git.julia.blue/fork/rust

borsAuto merge of #103046 - JanBeh:PR_clarify_cmp_terminology, r=workingjubilee3bcad65fbf6

master
1.3 KiB27 linesraw
1Available passes for running rustdoc:
2check-custom-code-classes - check for custom code classes without the feature-gate enabled
3check_doc_test_visibility - run various visibility-related lints on doctests
4        strip-hidden - strips all `#[doc(hidden)]` items from the output
5       strip-private - strips all private items from a crate which cannot be seen externally, implies strip-priv-imports
6  strip-priv-imports - strips all private import statements (`use`, `extern crate`) from a crate
7   propagate-doc-cfg - propagates `#[doc(cfg(...))]` to child items
8collect-intra-doc-links - resolves intra-doc links
9 collect-trait-impls - retrieves trait impls for items in the crate
10calculate-doc-coverage - counts the number of items with and without documentation
11           run-lints - runs some of rustdoc's lints
12
13Default passes for rustdoc:
14check-custom-code-classes
15 collect-trait-impls
16check_doc_test_visibility
17        strip-hidden  (when not --document-hidden-items)
18       strip-private  (when not --document-private-items)
19  strip-priv-imports  (when --document-private-items)
20collect-intra-doc-links
21   propagate-doc-cfg
22           run-lints
23
24Passes run with `--show-coverage`:
25        strip-hidden  (when not --document-hidden-items)
26       strip-private  (when not --document-private-items)
27calculate-doc-coverage