Docs: clarify @arg type vs signature type hint relationship - #44
Merged
Conversation
Agent-Logs-Url: https://github.com/nihilok/run/sessions/c554870a-7425-42dd-9b72-58df6c35826a Co-authored-by: nihilok <70285461+nihilok@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation to clarify @arg and signature type relationship
Docs: clarify @arg type vs signature type hint relationship
May 4, 2026
nihilok
approved these changes
May 4, 2026
nihilok
marked this pull request as ready for review
May 4, 2026 20:58
Owner
|
@copilot clippy is failing |
Agent-Logs-Url: https://github.com/nihilok/run/sessions/19e0dd22-cb97-45c0-b210-bd89a79b0355 Co-authored-by: nihilok <70285461+nihilok@users.noreply.github.com>
Author
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 docs showed both
@argtype keywords and signature type hints without explaining which wins, whether both are required, or what each one actually controls at runtime.Changes
docs/attributes-and-interpreters.md— Updated the@argbullet to note the type keyword is a fallback (not the primary driver), and added a blockquote callout spelling out the full precedence rules:@argtype is consulted only when there is no typed signature (legacy$1/$2-style shell functions)@argdescription is always used regardlessdocs/arguments.md— Added a summary sentence to the "Types in signatures" section with a cross-link to the detailed note abovePrecedence in one glance