agents(rules): document linking external objects in TypedDict docstrings - #4022
Merged
rickeylev merged 2 commits intoAug 9, 2026
Merged
Conversation
When defining TypedDict structures that represent external objects or schemas, agents and developers need clear provenance and context for the fields and their semantics. Update the agent Python rules to establish a convention requiring TypedDict docstrings to include a link to the external object's original definition.
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
1 participant
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.
When defining TypedDict structures that represent external objects or
schemas, agents and developers need clear provenance and context for
the fields and their semantics.
Update the agent Python rules to establish a convention requiring
TypedDict docstrings to include a link to the external object's
original definition.