feat: updated docs to make python api clearer#2326
Merged
Conversation
Contributor
Greptile SummaryThis PR adds new documentation sections to
Confidence Score: 5/5Documentation-only change with no effect on runtime behavior; safe to merge. All import paths and the Disposable-wrapping pattern for register_disposable were verified against the actual source. No code is modified. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Module.__init__] --> B[start]
B --> C["value.subscribe(handler)\nreturns unsubscribe fn"]
C --> D["Disposable(unsubscribe_fn)"]
D --> E["register_disposable(disposable)"]
E --> F[Module running\nhandler fires on message]
F --> G[stop]
G --> H["CompositeDisposable.dispose()\ncalls unsubscribe fn"]
H --> I[Handler detached]
subgraph Spec wiring
J[Coordinator deploy time] --> K["Resolves _notifier: NotifierSpec\nto matching module"]
K --> L[Proxy bound to field]
L --> M[Handler calls self._notifier.notify]
end
Reviews (3): Last reviewed commit: "Merge branch 'main' into paul/feat/claud..." | Re-trigger Greptile |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
leshy
approved these changes
Jun 2, 2026
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.
Problem
The docs for agents for Python API need to be improved.
Closes DIM-841
Solution
Contributor License Agreement