diff --git a/diagnostic_common_diagnostics/diagnostic_common_diagnostics/hd_monitor.py b/diagnostic_common_diagnostics/diagnostic_common_diagnostics/hd_monitor.py index 24c04d33..ac4eae74 100755 --- a/diagnostic_common_diagnostics/diagnostic_common_diagnostics/hd_monitor.py +++ b/diagnostic_common_diagnostics/diagnostic_common_diagnostics/hd_monitor.py @@ -64,7 +64,8 @@ class HDMonitor(Node): - """Diagnostic node checking the remaining space on the specified hard drive. + """ + Diagnostic node checking the remaining space on the specified hard drive. Three ROS parameters: - path: Path on the filesystem to check (string, default: home directory) @@ -90,7 +91,8 @@ def __init__(self): self._updater.add(f'{hostname} HD Usage', self.check_disk_usage) def callback_config(self, params: List[rclpy.Parameter]): - """Retrieve ROS parameters. + """ + Retrieve ROS parameters. see the class documentation for declared parameters. """ @@ -108,7 +110,8 @@ def callback_config(self, params: List[rclpy.Parameter]): return SetParametersResult(successful=True) def check_disk_usage(self, diag: DiagnosticStatus) -> DiagnosticStatus: - """Compute the disk usage and derive a status from it. + """ + Compute the disk usage and derive a status from it. Task periodically ran by the diagnostic updater. """