v2 doc and demo updates#384
Merged
pavel-kirienko merged 7 commits intomasterfrom Apr 12, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the v2 documentation/demo materials and aligns the codebase/tests with an updated Topic/Node public API (exposing Node.transport, adding Topic.evictions, and making subject-id computation explicit via Topic.subject_id(modulus)).
Changes:
- Update the public API: add
Node.transport, addTopic.evictions, and changeTopic.subject_idinto a method requiring the subject-id modulus. - Adjust tests and the monitor example to use the new subject-id API and surface eviction/subject-id info for monitored topics.
- Refresh docs/readme styling/content and bump package version.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_topic.py | Update topic subject-id assertions to call subject_id(modulus). |
| tests/test_reliable.py | Update reliable-path tests to compute subject-id via subject_id(modulus) for arrivals and comparisons. |
| tests/test_parity.py | Update parity tests to use the new Topic.subject_id(modulus) API. |
| tests/test_monitor.py | Add assertions for flyweight topic evictions/subject_id(modulus) and update subject arrival calls. |
| tests/test_integration.py | Add coverage for Node.transport and update pinned topic subject-id assertions. |
| tests/test_gossip.py | Update gossip tests to use subject_id(modulus). |
| src/pycyphal2/can/init.py | Docstring link formatting update. |
| src/pycyphal2/_node.py | Implement flyweight evictions + new subject-id API; add NodeImpl.transport property; refactor evictions storage/mutation. |
| src/pycyphal2/_api.py | Extend public ABCs with Topic.evictions, Topic.subject_id(modulus), and Node.transport. |
| src/pycyphal2/init.py | Expand top-level package docstring and bump __version__. |
| README.md | Update project intro/badges and positioning text for pycyphal2 vs pycyphal. |
| examples/monitor.py | Improve monitor display; include evictions/subject-id; use Node.transport.subject_id_modulus. |
| docs/pdoc/theme.css | Adjust docstring heading styling in generated docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.