Skip to content

Commit

Permalink
use a consistent example
Browse files Browse the repository at this point in the history
  • Loading branch information
ntBre committed Feb 11, 2025
1 parent f377a43 commit 6e64c4c
Showing 1 changed file with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ use crate::settings::LinterSettings;
/// [`lint.flake8-builtins.builtins-allowed-modules`] configuration option.
///
/// By default, only the last component of the module name is considered, so `logging.py`,
/// `a/logging.py`, `a/b/logging.py`, and so on would all clash with the builtin `logging` module.
/// With the [`lint.flake8-builtins.builtins-strict-checking`] option set to `false`, the module
/// path is considered, so only a top-level `logging.py` or `logging/__init__.py` will trigger the
/// rule and `utils/logging.py`, for example, would not.
/// `utils/logging.py`, and `utils/logging/__init__.py` would all clash with the builtin `logging`
/// module. With the [`lint.flake8-builtins.builtins-strict-checking`] option set to `false`, the
/// module path is considered, so only a top-level `logging.py` or `logging/__init__.py` will
/// trigger the rule and `utils/logging.py`, for example, would not.
///
/// This rule is not applied to stub files, as the name of a stub module is out
/// of the control of the author of the stub file. Instead, a stub should aim to
Expand Down

0 comments on commit 6e64c4c

Please sign in to comment.