From 39bf956758d80b3854f41829aff46215f78e11de Mon Sep 17 00:00:00 2001 From: Nathan McDougall Date: Fri, 27 Feb 2026 17:20:38 +1300 Subject: [PATCH] Clarify intent of Tool.name in docstring --- src/usethis/_tool/base.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/usethis/_tool/base.py b/src/usethis/_tool/base.py index aec94f94..e2fc7b4f 100644 --- a/src/usethis/_tool/base.py +++ b/src/usethis/_tool/base.py @@ -56,6 +56,12 @@ def name(self) -> str: It is assumed that this name is also the name of the Python package associated with the tool; if not, make sure to override methods which access this property. + + This is the display-friendly (e.g. brand compliant) name of the tool, not the + name of a CLI command, etc. Pay mind to the correct capitalization. + + For example, the tool named `ty` has a name of `ty`, not `Ty` or `TY`. + Import Linter has a name of `Import Linter`, not `import-linter`. """ @abstractmethod