Skip to content

Commit b080d1c

Browse files
committed
Cleanup rustdoc pass descriptions a bit
Also changed a couple of comments from "intra-doc-links" to "intra-doc links" (my understanding is that "intra-doc links" is the standard way to refer to them).
1 parent e708cbd commit b080d1c

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

src/librustdoc/core.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -435,7 +435,7 @@ crate fn create_resolver<'a>(
435435

436436
// Before we actually clone it, let's force all the extern'd crates to
437437
// actually be loaded, just in case they're only referred to inside
438-
// intra-doc-links
438+
// intra-doc links
439439
resolver.borrow_mut().access(|resolver| {
440440
sess.time("load_extern_crates", || {
441441
for extern_name in &extern_names {

src/librustdoc/passes/collect_intra_doc_links.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ use super::span_of_attrs;
4444
crate const COLLECT_INTRA_DOC_LINKS: Pass = Pass {
4545
name: "collect-intra-doc-links",
4646
run: collect_intra_doc_links,
47-
description: "reads a crate's documentation to resolve intra-doc-links",
47+
description: "resolves intra-doc links",
4848
};
4949

5050
crate fn collect_intra_doc_links(krate: Crate, cx: &DocContext<'_>) -> Crate {
@@ -981,7 +981,7 @@ impl LinkCollector<'_, '_> {
981981
let link_text =
982982
disambiguator.map(|d| d.display_for(path_str)).unwrap_or_else(|| path_str.to_owned());
983983

984-
// In order to correctly resolve intra-doc-links we need to
984+
// In order to correctly resolve intra-doc links we need to
985985
// pick a base AST node to work from. If the documentation for
986986
// this module came from an inner comment (//!) then we anchor
987987
// our name resolution *inside* the module. If, on the other

src/librustdoc/passes/doc_test_lints.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//! This pass is overloaded and runs two different lints.
22
//!
3-
//! - MISSING_DOC_CODE_EXAMPLES: this lint is **UNSTABLE** and looks for public items missing doc-tests
4-
//! - PRIVATE_DOC_TESTS: this lint is **STABLE** and looks for private items with doc-tests.
3+
//! - MISSING_DOC_CODE_EXAMPLES: this lint is **UNSTABLE** and looks for public items missing doctests
4+
//! - PRIVATE_DOC_TESTS: this lint is **STABLE** and looks for private items with doctests.
55
66
use super::{span_of_attrs, Pass};
77
use crate::clean;

src/librustdoc/passes/non_autolinks.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ use rustc_session::lint;
1212
crate const CHECK_NON_AUTOLINKS: Pass = Pass {
1313
name: "check-non-autolinks",
1414
run: check_non_autolinks,
15-
description: "detects URLS that could be written using angle brackets",
15+
description: "detects URLs that could be linkified",
1616
};
1717

1818
const URL_REGEX: &str = concat!(

src/librustdoc/passes/strip_hidden.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ use crate::passes::{ImplStripper, Pass};
1111
crate const STRIP_HIDDEN: Pass = Pass {
1212
name: "strip-hidden",
1313
run: strip_hidden,
14-
description: "strips all doc(hidden) items from the output",
14+
description: "strips all `#[doc(hidden)]` items from the output",
1515
};
1616

1717
/// Strip items marked `#[doc(hidden)]`

0 commit comments

Comments
 (0)