Skip to content

Commit 9aec8e3

Browse files
rustyconoverclaude
andcommitted
docs: complete the CountdownState codec docstring
pydoclint (run as a test here, unlike vgi-rpc where it is a CI step) wants Args and Returns on the deserialize side. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 273110d commit 9aec8e3

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

‎vgi/_test_fixtures/table/_common.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,12 @@ def serialize_to_bytes(self) -> bytes:
7676
def deserialize_from_bytes(cls, data: bytes) -> CountdownState:
7777
"""Unpack a payload written by :meth:`serialize_to_bytes`.
7878
79+
Args:
80+
data: The packed bytes, exactly two little-endian int64s.
81+
82+
Returns:
83+
The restored counter pair.
84+
7985
Raises:
8086
ValueError: The payload is not the expected width, which means it
8187
was not written by this codec.

0 commit comments

Comments
 (0)