Closed
Conversation
Add class-level docstrings clarifying the key distinction: - ToolSpec: factual, non-opinionated, stable specification of a tool - Tool: opinionated, heuristic, pragmatic operations with side-effects Also update module-level docstrings, clarify the rule_config docstring, and add notes on borderline methods (is_config_present, how_to_use_pre_commit_hook_id) that could arguably live in ToolSpec. Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/c531fdc1-bb25-4d66-a6fd-4d71b150e9f8 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update docstrings for Tool and ToolSpec to clarify distinctions
Improve docstrings for Mar 27, 2026
Tool and ToolSpec
Collaborator
|
Hmmm this is quite useful but shows my thinking is still muddled. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The distinction between
ToolSpecandToolwas undocumented, leading to confusion about where new methods belong.Changes
ToolSpecandTool:ToolSpec= factual, non-opinionated, stable specification of a third-party tool.Tool= opinionated, heuristic operations with side-effects (adding/removing config, detecting usage, presenting instructions). Potentially less stable.spec.pyandbase.pyupdated to reflect this framing.rule_configdocstring clarified — previously described as "static, opinionated" which was misleading in a ToolSpec context. Now notes the rule choices are opinionated by usethis, but the specification itself is factual metadata.is_config_present()andhow_to_use_pre_commit_hook_id()are read-only queries that could arguably live inToolSpec— added docstring notes explaining why they're placed inTool(primarily consumed by Tool's mutating operations).Method placement analysis
All current methods are appropriately placed. No methods need to move. The two borderline cases (
is_config_present,how_to_use_pre_commit_hook_id) are documented with rationale for their current placement inTool.⚡ Quickly spin up Copilot coding agent tasks from anywhere on your macOS or Windows machine with Raycast.