Skip to content

Commit 50ccd81

Browse files
authored
Merge pull request #274 from PragatiGHub/improve-inline-docs
Add inline documentation for core modules (comms, libs, ram_logging)
2 parents 9384822 + 08a3b9a commit 50ccd81

3 files changed

Lines changed: 18 additions & 0 deletions

File tree

robotics_application_manager/comms/__init__.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
"""
2+
Communication module for Robotics Application Manager.
3+
4+
Provides classes and utilities for handling communication
5+
between the manager backend and client applications.
6+
"""
17
from .new_consumer import ManagerConsumer
28
from .consumer_message import ManagerConsumerMessageException, ManagerConsumerMessage
39
from .thread import ThreadWithLoggedException, WebsocketServerThread

robotics_application_manager/libs/__init__.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
"""
2+
Utility library module for Robotics Application Manager.
3+
4+
Contains helper functions for configuration handling,
5+
process management, and GPU acceleration detection.
6+
"""
17
from .file_watchdog import FileWatchdog
28
from .launch_world_model import ConfigurationModel, ConfigurationManager
39
from .process_utils import (
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1+
"""
2+
Logging utilities for Robotics Application Manager.
3+
4+
This module initializes the logging configuration used
5+
throughout the RAM system.
6+
"""
17
from .log_manager import LogManager

0 commit comments

Comments
 (0)