docs(actions): add docstrings to base action classes #1908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

EMRAHFC wants to merge 1 commit into OpenMind:main from EMRAHFC:docs/add-docstrings-base-actions

EMRAHFC commented Jan 26, 2026

Overview

Added comprehensive Google style docstrings to base action classes for improved code documentation and better IDE support.

Type of change

Changes

src/actions/base.py:
- Added class docstring to MoveCommand with attribute descriptions
- Added method docstring to ActionConfig.__init__()
- Added class docstring to ActionConnector
- Added method docstrings to ActionConnector.__init__(), connect(), and tick()
- Added class docstring to AgentAction with attribute descriptions
- Added docstring to Interface class

Checklist

Code complies with style guidelines
Self-review completed
Documentation updated (if applicable)
Local testing completed


          docs(actions): add docstrings to base action classes

ae6655d

EMRAHFC requested review from a team as code owners

January 26, 2026 12:30

github-actions bot added robotics python labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

python robotics