Skip to content

Commit e09d572

Browse files
committed
added ByteStream protocol, take 2
1 parent e0c3ab5 commit e09d572

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

circuitpython_typing/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ class ByteStream(Protocol):
4343
"""
4444

4545
def read(self, count: Optional[int] = None, /) -> Optional[bytes]:
46-
"""Read `count` bytes from the stream.
47-
If `count` bytes are not immediately available,
46+
"""Read ``count`` bytes from the stream.
47+
If ``count`` bytes are not immediately available,
4848
or if the parameter is not specified in the call,
4949
the outcome is implementation-dependent.
5050
"""
5151
...
5252

5353
def write(self, buf: ReadableBuffer, /) -> Optional[int]:
54-
"""Write the bytes in `buf` to the stream."""
54+
"""Write the bytes in ``buf`` to the stream."""
5555
...

0 commit comments

Comments
 (0)