Skip to content

Commit 8a00d7a

Browse files
committed
docs: include distinct type declarations in codec module
1 parent bdd5a92 commit 8a00d7a

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

docs/api/codec.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ SPDX-License-Identifier: CC0-1.0
2020

2121
## Data classes & types
2222

23+
::: pykmp.codec.PhysicalBytes
24+
::: pykmp.codec.DataLinkBytes
25+
::: pykmp.codec.ApplicationBytes
26+
::: pykmp.codec.ApplicationDataBytes
2327
::: pykmp.codec.ApplicationData
2428
::: pykmp.codec.DataLinkData
2529
::: pykmp.codec.PhysicalDirection

src/pykmp/codec.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,16 @@
3030

3131

3232
PhysicalBytes = NewType("PhysicalBytes", bytes)
33+
"""Distinct type (bytes) representing serialized bytes on the physical layer."""
34+
3335
DataLinkBytes = NewType("DataLinkBytes", bytes)
36+
"""Distinct type (bytes) representing serialized bytes on the data link layer."""
37+
3438
ApplicationBytes = NewType("ApplicationBytes", bytes)
39+
"""Distinct type (bytes) representing serialized data on the application layer."""
40+
3541
ApplicationDataBytes = NewType("ApplicationDataBytes", bytes)
42+
"""Distinct type (bytes) representing serialized application (message) data."""
3643

3744

3845
class AckReceivedException(Exception): # noqa: N818

0 commit comments

Comments
 (0)