From 6e64c4c93d6b89426e7e8c487055d7061504efc2 Mon Sep 17 00:00:00 2001 From: Brent Westbrook Date: Tue, 11 Feb 2025 11:46:29 -0500 Subject: [PATCH] use a consistent example --- .../flake8_builtins/rules/stdlib_module_shadowing.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/crates/ruff_linter/src/rules/flake8_builtins/rules/stdlib_module_shadowing.rs b/crates/ruff_linter/src/rules/flake8_builtins/rules/stdlib_module_shadowing.rs index 363a4f0d2f211..cd20675821c63 100644 --- a/crates/ruff_linter/src/rules/flake8_builtins/rules/stdlib_module_shadowing.rs +++ b/crates/ruff_linter/src/rules/flake8_builtins/rules/stdlib_module_shadowing.rs @@ -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