Require event hints for remote protocol errors#202
Open
Mirochill wants to merge 3 commits into
Open
Conversation
Member
|
Please add a changelog entry to document the API breaking change as minor. Also add the corresponding source-code comment annotation. |
Kriechi
reviewed
May 18, 2026
| """ | ||
|
|
||
| # API-breaking change for the next minor release: event_hint is required. |
Member
There was a problem hiding this comment.
I was thinking about https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionchanged
example:
.. versionchanged:: 2.3.0
Changed the type of ``headers`` to :class:`HeaderTuple
<hpack:hpack.HeaderTuple>`. This has no effect on current users.
Contributor
Author
|
Thanks, this is addressed in the follow-up commits: b1dc8d5 adds the 1.4.0 changelog entry, and f40f1b3 replaces the source note with a Remote checks now show the published |
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.
Summary
RemoteProtocolError.event_hinta required constructor argumentWhy
Issue #178 notes that every
wsprotocall site already supplies anevent_hint, while the public signature still allows callers to construct aRemoteProtocolErrorwithout one. Requiring the argument makes the API describe the behavior the implementation already depends on and gives consumers a stable hint to react to.This is intentionally an API-breaking change, matching the maintainer note that the issue is a candidate for a future minor API-breaking release.
Validation
RemoteProtocolError(...)call sites already provideevent_hint=.