Skip to main content

Module check_doc_test_visibility

Module check_doc_test_visibility 

Source
Expand description

Looks for items missing (or incorrectly having) doctests.

This pass is overloaded and runs two different lints.

  • MISSING_DOC_CODE_EXAMPLES: this lint is UNSTABLE and looks for public items missing doctests.
  • PRIVATE_DOC_TESTS: this lint is STABLE and looks for private items with doctests.

Re-exportsยง

use rustc_hir as hir; ๐Ÿ”’
use rustc_macros::Diagnostic; ๐Ÿ”’
use rustc_middle::lint::LintLevelSource; ๐Ÿ”’
use tracing::debug; ๐Ÿ”’
use crate::clean::utils::inherits_doc_hidden; ๐Ÿ”’
use crate::clean; ๐Ÿ”’
use crate::core::DocContext; ๐Ÿ”’
use crate::html::markdown::CodeBlockPosition; ๐Ÿ”’
use crate::html::markdown::CodeLineMapping; ๐Ÿ”’
use crate::html::markdown::ErrorCodes; ๐Ÿ”’
use crate::html::markdown::Ignore; ๐Ÿ”’
use crate::html::markdown::LangString; ๐Ÿ”’
use crate::html::markdown::find_testable_code; ๐Ÿ”’
use crate::visit::DocVisitor; ๐Ÿ”’
use crate::clean::*; ๐Ÿ”’

Structsยง

DocTestVisibilityLinter ๐Ÿ”’
Tests ๐Ÿ”’

Functionsยง

check_doc_test_visibility ๐Ÿ”’
look_for_tests ๐Ÿ”’
should_have_doc_example ๐Ÿ”’