Skip to content

Commit

Permalink
Document that type imports are ignored
Browse files Browse the repository at this point in the history
  • Loading branch information
tjkuson committed Dec 21, 2023
1 parent 3e28855 commit 44cc626
Showing 1 changed file with 4 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ use crate::checkers::ast::Checker;
/// Checks for import statements that import a private name (a name starting
/// with an underscore `_`) from another module.
///
/// Ignores private name imports that are used for type annotations. Ideally,
/// types would be public; however, this is not always possible when using
/// third-party libraries.
///
/// ## Why is this bad?
/// [PEP 8] states that names starting with an underscore are private. Thus,
/// they are not intended to be used outside of the module in which they are
Expand Down

0 comments on commit 44cc626

Please sign in to comment.