Move class docstrings out of init function.

This commit is contained in:
Marek Wolan
2023-07-05 10:14:16 +01:00
parent 24a4f96ed0
commit fa6dbd8338
12 changed files with 105 additions and 123 deletions

View File

@@ -6,7 +6,15 @@ from primaite.nodes.node import Node
class PassiveNode(Node):
"""The Passive Node class."""
"""The Passive Node class.
:param node_id: The node id.
:param name: The name of the node.
:param node_type: The type of the node.
:param priority: The priority of the node.
:param hardware_state: The state of the node.
:param config_values: Config values.
"""
def __init__(
self,
@@ -17,15 +25,6 @@ class PassiveNode(Node):
hardware_state: HardwareState,
config_values: TrainingConfig,
):
"""Init.
:param node_id: The node id.
:param name: The name of the node.
:param node_type: The type of the node.
:param priority: The priority of the node.
:param hardware_state: The state of the node.
:param config_values: Config values.
"""
# Pass through to Super for now
super().__init__(node_id, name, node_type, priority, hardware_state, config_values)