docs: Document named argument name/position assumption#17
Merged
Conversation
Investigates and documents the potential ambiguity between Python
attribute names and SQL keys for named arguments.
Findings:
- For named args, the schema stores only the Python attribute name
- If attr name differs from SQL key, position is lost during round-trip
- Example: output_format = Arg[str]("format") loses "format" after round-trip
Resolution: Documents this as a known limitation and recommends using
matching names (the standard convention).
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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.
Summary
Investigates and documents the potential ambiguity between Python attribute names and SQL keys for named arguments.
Findings
output_format = Arg[str]("format")loses"format"after round-tripResolution
Documents this as a known limitation and recommends the standard convention of using matching names:
Test plan
Closes vgi-python-j8a
🤖 Generated with Claude Code