Skip to content

Commit 92a3986

Browse files
committed
Improve comments for pdoc
1 parent f08ec18 commit 92a3986

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

meshtastic/__init__.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,19 +134,21 @@ class ResponseHandler(NamedTuple):
134134
"""A pending response callback, waiting for a response to one of our messages"""
135135

136136
# requestId: int - used only as a key
137+
#: a callable to call when a response is received
137138
callback: Callable
139+
#: Whether ACKs and NAKs should be passed to this handler
138140
ackPermitted: bool = False
139141
# FIXME, add timestamp and age out old requests
140142

141143

142144
class KnownProtocol(NamedTuple):
143145
"""Used to automatically decode known protocol payloads"""
144146

147+
#: A descriptive name (e.g. "text", "user", "admin")
145148
name: str
146-
# portnum: int, now a key
147-
# If set, will be called to prase as a protocol buffer
149+
#: If set, will be called to parse as a protocol buffer
148150
protobufFactory: Optional[Callable] = None
149-
# If set, invoked as onReceive(interface, packet)
151+
#: If set, invoked as onReceive(interface, packet)
150152
onReceive: Optional[Callable] = None
151153

152154

0 commit comments

Comments
 (0)