Skip to content

Describe the low-level API#1

Open
griffinmilsap wants to merge 2 commits intomainfrom
low-level-api
Open

Describe the low-level API#1
griffinmilsap wants to merge 2 commits intomainfrom
low-level-api

Conversation

@griffinmilsap
Copy link

Adds description of low-level API and highlights examples described in ezmsg-org/ezmsg#215

@griffinmilsap griffinmilsap changed the title added description for low-level api Describe the low-level API Feb 13, 2026
@KonradPilch
Copy link

Great work Griffin!

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments