docs: keep engine and transfer-core comments consumer-agnostic#95
Merged
Davidobot merged 1 commit intoJul 20, 2026
Merged
Conversation
Reword doc comments that described one deployment's architecture around the generic mechanism, and drop references to internal planning notes. Comments and docs only; no code or contract changes.
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.
What & why
Doc-comment and docs-only pass over the engine, the PyO3 bindings, and the transfer core: reword comments that described one deployment's architecture in terms of the generic mechanism (producer/caller rather than named pipeline roles, encode-time rather than transfer framing), and drop references to internal planning notes that don't belong in code comments. Trims one matching sentence in the v1.3.2 CHANGELOG entry. No code, API, or contract changes — every documented engine invariant stays documented.
How it was tested
uv run pytest tests/test_segments.py -q— 9 passed (covers the touched Python files).uv run ruff checkon the touched Python files — clean.Ground rules (see CONTRIBUTING.md)
tests/test_import_boundary.pyunaffected