Skip to content

Commit e3c0432

Browse files
committed
Fix some docstrings on the PDO classes.
Follow the standard docstring conventions and rephrase the description of RPDO and TPDO classes which is really long for a single summary line. No more docstring errors are reported by the flake8 checker on this file.
1 parent 1f456a4 commit e3c0432

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

canopen/pdo/__init__.py

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88

99

1010
class PDO(PdoBase):
11-
"""PDO Class for backwards compatibility
11+
"""PDO Class for backwards compatibility.
12+
1213
:param rpdo: RPDO object holding the Receive PDO mappings
1314
:param tpdo: TPDO object holding the Transmit PDO mappings
1415
"""
@@ -27,9 +28,11 @@ def __init__(self, node, rpdo, tpdo):
2728

2829

2930
class RPDO(PdoBase):
30-
"""PDO specialization for the Receive PDO enabling the transfer of data from the master to the node.
31+
"""Receive PDO to transfer data from somewhere to the represented node.
32+
3133
Properties 0x1400 to 0x1403 | Mapping 0x1600 to 0x1603.
32-
:param object node: Parent node for this object."""
34+
:param object node: Parent node for this object.
35+
"""
3336

3437
def __init__(self, node):
3538
super(RPDO, self).__init__(node)
@@ -38,8 +41,10 @@ def __init__(self, node):
3841

3942
def stop(self):
4043
"""Stop transmission of all RPDOs.
44+
4145
:raise TypeError: Exception is thrown if the node associated with the PDO does not
42-
support this function"""
46+
support this function.
47+
"""
4348
if isinstance(self.node, canopen.RemoteNode):
4449
for pdo in self.map.values():
4550
pdo.stop()
@@ -48,8 +53,11 @@ def stop(self):
4853

4954

5055
class TPDO(PdoBase):
51-
"""PDO specialization for the Transmit PDO enabling the transfer of data from the node to the master.
52-
Properties 0x1800 to 0x1803 | Mapping 0x1A00 to 0x1A03."""
56+
"""Transmit PDO to broadcast data from the represented node to the network.
57+
58+
Properties 0x1800 to 0x1803 | Mapping 0x1A00 to 0x1A03.
59+
:param object node: Parent node for this object.
60+
"""
5361

5462
def __init__(self, node):
5563
super(TPDO, self).__init__(node)
@@ -58,8 +66,10 @@ def __init__(self, node):
5866

5967
def stop(self):
6068
"""Stop transmission of all TPDOs.
69+
6170
:raise TypeError: Exception is thrown if the node associated with the PDO does not
62-
support this function"""
71+
support this function.
72+
"""
6373
if isinstance(canopen.LocalNode, self.node):
6474
for pdo in self.map.values():
6575
pdo.stop()

0 commit comments

Comments
 (0)