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.

Structs§

DocTestVisibilityLinter 🔒
Tests 🔒

Constants§

CHECK_DOC_TEST_VISIBILITY 🔒

Functions§

check_doc_test_visibility 🔒
look_for_tests 🔒
should_have_doc_example 🔒