Skip to content

Document connection state transition timing#201

Merged
Kriechi merged 1 commit into
python-hyper:mainfrom
Mirochill:docs-181-state-change-timing
May 18, 2026
Merged

Document connection state transition timing#201
Kriechi merged 1 commit into
python-hyper:mainfrom
Mirochill:docs-181-state-change-timing

Conversation

@Mirochill
Copy link
Copy Markdown
Contributor

Summary

  • clarify that received bytes are parsed by receive_data() while event-driven state changes are applied as events() is consumed
  • document the remote-close case explicitly in both the generated API docs and the Connection method docstrings

Why

Issue #181 points out that it is easy to assume a remote close frame moves the connection into REMOTE_CLOSING during receive_data(), when the current implementation actually performs that transition while yielding the corresponding CloseConnection event from events().

Validation

  • No local validation run, per this workspace's coordination-only policy.
  • Relying on static review of the diff and the repository's remote CI.

@Mirochill Mirochill marked this pull request as ready for review May 18, 2026 17:35
@Kriechi Kriechi merged commit b2239f4 into python-hyper:main May 18, 2026
7 of 8 checks passed
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