Skip to content

Commit 047a52d

Browse files
committed
Add a few missing docstrings
1 parent 3268114 commit 047a52d

3 files changed

Lines changed: 21 additions & 0 deletions

File tree

src/eolib/data/eo_writer.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,14 @@
44

55

66
class EoWriter:
7+
"""
8+
A class for writing EO data to a sequence of bytes.
9+
"""
10+
711
def __init__(self):
12+
"""
13+
Creates a new ``EoWriter`` with no data.
14+
"""
815
self.data = bytearray()
916
self._string_sanitization_mode = False
1017

src/eolib/packet/sequence_start.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,19 @@ def zero() -> 'SequenceStart':
2929

3030

3131
class SimpleSequenceStart(SequenceStart):
32+
"""
33+
A simple ``SequenceStart`` implementation backed by a single integer value.
34+
"""
35+
3236
_value: int
3337

3438
def __init__(self, value: int):
39+
"""
40+
Creates a ``SimpleSequenceStart`` from an integer value.
41+
42+
Args:
43+
value (int): The sequence start value.
44+
"""
3545
self._value = value
3646

3747
@property

src/eolib/protocol/protocol_enum_meta.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33

44
class ProtocolEnumMeta(EnumMeta):
5+
"""
6+
Enum metaclass that preserves unrecognized values as synthetic enum members.
7+
"""
8+
59
def __call__(cls, value, names=None, *, module=None, qualname=None, type=None, start=1):
610
if names is not None:
711
return super().__call__(

0 commit comments

Comments
 (0)