Uh oh!
There was an error while loading. Please reload this page.
Require event hints for remote protocol errors - #202
Conversation
Kriechi
commented
May 18, 2026
Please add a changelog entry to document the API breaking change as minor. Also add the corresponding source-code comment annotation. |
| """ | ||
| # API-breaking change for the next minor release: event_hint is required. |
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.
Thanks, this is addressed in the follow-up commits: Remote checks now show the published |
Uh oh!
There was an error while loading. Please reload this page.
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=.