Open
Conversation
|
Great work Griffin! |
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation for ezmsg's low-level API, explaining how it differs from the high-level API and when to use each. The new documentation page helps users understand the publish/subscribe messaging primitives that underlie ezmsg and provides guidance on choosing between the low-level and high-level APIs based on their use case.
Changes:
- Added a new explanation page documenting the low-level API architecture and use cases
- Updated the explanations table of contents to include the new low-level API documentation
- Added references to example scripts demonstrating low-level API usage in both synchronous and asynchronous styles
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/source/explanations/low-level-api.rst | New documentation page explaining low-level API concepts, comparing it with high-level API, and providing guidance on choosing between them |
| docs/source/explanations/content-explanations.rst | Added low-level-api to the toctree to include it in the documentation structure |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
KonradPilch
approved these changes
Feb 18, 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.
Adds description of low-level API and highlights examples described in ezmsg-org/ezmsg#215