Skip to content

agents(rules): document linking external objects in TypedDict docstrings #4022

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
rickeylev merged 2 commits into from
Aug 9, 2026
+4 −0
Merged

agents(rules): document linking external objects in TypedDict docstrings #4022

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
312bb8c
agents(rules): document linking external objects in TypedDict docstrings
rickeylev Aug 9, 2026
7ec3da6
Merge remote-tracking branch 'upstream/main' into update_typeddict_do…
rickeylev Aug 9, 2026
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
4 changes: 4 additions & 0 deletions .agents/rules/python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@
* Use direct attribute access (e.g. `args.foo`) on `argparse.Namespace` with
well-defined shapes. Avoid defensive `getattr()`.

## TypedDict
* **External Objects**: When defining a `TypedDict` for an external object,
link to its definition in the docstring.