Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit abbead7

Browse files
committedOct 2, 2021
rustdoc: Improve doctest pass's name and module's name
As the docs at the top of the file say, it is an overloaded pass and actually runs two lints.
1 parent d14731c commit abbead7

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed
 

‎src/librustdoc/passes/calculate_doc_coverage.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use crate::clean;
22
use crate::core::DocContext;
33
use crate::fold::{self, DocFolder};
44
use crate::html::markdown::{find_testable_code, ErrorCodes};
5-
use crate::passes::doc_test_lints::{should_have_doc_example, Tests};
5+
use crate::passes::check_doc_test_visibility::{should_have_doc_example, Tests};
66
use crate::passes::Pass;
77
use rustc_hir as hir;
88
use rustc_lint::builtin::MISSING_DOCS;

‎src/librustdoc/passes/doc_test_lints.rs ‎src/librustdoc/passes/check_doc_test_visibility.rs

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
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 doctests
3+
//! - MISSING_DOC_CODE_EXAMPLES: this lint is **UNSTABLE** and looks for public items missing doctests.
44
//! - PRIVATE_DOC_TESTS: this lint is **STABLE** and looks for private items with doctests.
55
66
use super::Pass;
@@ -15,23 +15,23 @@ use rustc_middle::lint::LintLevelSource;
1515
use rustc_session::lint;
1616
use rustc_span::symbol::sym;
1717

18-
crate const CHECK_PRIVATE_ITEMS_DOC_TESTS: Pass = Pass {
19-
name: "check-private-items-doc-tests",
20-
run: check_private_items_doc_tests,
21-
description: "check private items doc tests",
18+
crate const CHECK_DOC_TEST_VISIBILITY: Pass = Pass {
19+
name: "check_doc_test_visibility",
20+
run: check_doc_test_visibility,
21+
description: "run various visibility-related lints on doctests",
2222
};
2323

24-
struct PrivateItemDocTestLinter<'a, 'tcx> {
24+
struct DocTestVisibilityLinter<'a, 'tcx> {
2525
cx: &'a mut DocContext<'tcx>,
2626
}
2727

28-
crate fn check_private_items_doc_tests(krate: Crate, cx: &mut DocContext<'_>) -> Crate {
29-
let mut coll = PrivateItemDocTestLinter { cx };
28+
crate fn check_doc_test_visibility(krate: Crate, cx: &mut DocContext<'_>) -> Crate {
29+
let mut coll = DocTestVisibilityLinter { cx };
3030

3131
coll.fold_crate(krate)
3232
}
3333

34-
impl<'a, 'tcx> DocFolder for PrivateItemDocTestLinter<'a, 'tcx> {
34+
impl<'a, 'tcx> DocFolder for DocTestVisibilityLinter<'a, 'tcx> {
3535
fn fold_item(&mut self, item: Item) -> Option<Item> {
3636
let dox = item.attrs.collapsed_doc_value().unwrap_or_else(String::new);
3737

‎src/librustdoc/passes/mod.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ crate use self::propagate_doc_cfg::PROPAGATE_DOC_CFG;
3333
crate mod collect_intra_doc_links;
3434
crate use self::collect_intra_doc_links::COLLECT_INTRA_DOC_LINKS;
3535

36-
mod doc_test_lints;
37-
crate use self::doc_test_lints::CHECK_PRIVATE_ITEMS_DOC_TESTS;
36+
mod check_doc_test_visibility;
37+
crate use self::check_doc_test_visibility::CHECK_DOC_TEST_VISIBILITY;
3838

3939
mod collect_trait_impls;
4040
crate use self::collect_trait_impls::COLLECT_TRAIT_IMPLS;
@@ -79,7 +79,7 @@ crate enum Condition {
7979

8080
/// The full list of passes.
8181
crate const PASSES: &[Pass] = &[
82-
CHECK_PRIVATE_ITEMS_DOC_TESTS,
82+
CHECK_DOC_TEST_VISIBILITY,
8383
STRIP_HIDDEN,
8484
UNINDENT_COMMENTS,
8585
STRIP_PRIVATE,
@@ -97,7 +97,7 @@ crate const PASSES: &[Pass] = &[
9797
crate const DEFAULT_PASSES: &[ConditionalPass] = &[
9898
ConditionalPass::always(COLLECT_TRAIT_IMPLS),
9999
ConditionalPass::always(UNINDENT_COMMENTS),
100-
ConditionalPass::always(CHECK_PRIVATE_ITEMS_DOC_TESTS),
100+
ConditionalPass::always(CHECK_DOC_TEST_VISIBILITY),
101101
ConditionalPass::new(STRIP_HIDDEN, WhenNotDocumentHidden),
102102
ConditionalPass::new(STRIP_PRIVATE, WhenNotDocumentPrivate),
103103
ConditionalPass::new(STRIP_PRIV_IMPORTS, WhenDocumentPrivate),

0 commit comments

Comments
 (0)
Failed to load comments.