Skip to content

Fix wrong example in Protocol documentation (#2176) #2177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
e1turin wants to merge 2 commits into from
+8 −5
Closed

Fix wrong example in Protocol documentation (#2176) #2177

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
243393d
Correctly mark the error case in example of protocol implementation f…
e1turin Feb 13, 2026
b3497a1
Format code in common style in example of protocol implementation for…
e1turin Feb 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions docs/spec/protocol.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,15 +502,18 @@ For example::
from typing import Any, Protocol

class ProtoA(Protocol):
def meth(self, x: int) -> int: ...
def meth(self, x: int) -> int:
...
class ProtoB(Protocol):
def meth(self, obj: Any, x: int) -> int: ...
def meth(self, obj: Any, x: int) -> int:
...

class C:
def meth(self, x: int) -> int: ...
def meth(self, x: int) -> int:
...

a: ProtoA = C # Type check error, signatures don't match!
b: ProtoB = C # OK
a: ProtoA = C() # OK
b: ProtoB = C() # Error: signatures don't match

.. _`protocol-newtype-aliases`:

Expand Down