Skip to content

Clarify intent of Tool.name in docstring #1317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanjmcdougall merged 1 commit into from
Feb 27, 2026
Merged

Clarify intent of Tool.name in docstring #1317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/usethis/_tool/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down