Skip to content

v2 doc and demo updates#384

Merged
pavel-kirienko merged 7 commits intomasterfrom
dev
Apr 12, 2026
Merged

v2 doc and demo updates#384
pavel-kirienko merged 7 commits intomasterfrom
dev

Conversation

@pavel-kirienko
Copy link
Copy Markdown
Member

No description provided.

@pavel-kirienko pavel-kirienko requested a review from Copilot April 12, 2026 08:51
@pavel-kirienko pavel-kirienko self-assigned this Apr 12, 2026
@pavel-kirienko pavel-kirienko marked this pull request as ready for review April 12, 2026 08:53
Copy link
Copy Markdown

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 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, add Topic.evictions, and change Topic.subject_id into 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.

Comment thread src/pycyphal2/_api.py
Comment thread src/pycyphal2/__init__.py
@pavel-kirienko pavel-kirienko merged commit d21094a into master Apr 12, 2026
22 checks passed
@pavel-kirienko pavel-kirienko deleted the dev branch April 12, 2026 09:08
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