docs(battery_turtlebot4): add missing __init__ docstring#1415
Merged
openminddev merged 2 commits intoOpenMind:mainfrom Jan 14, 2026
Merged
docs(battery_turtlebot4): add missing __init__ docstring#1415openminddev merged 2 commits intoOpenMind:mainfrom
openminddev merged 2 commits intoOpenMind:mainfrom
Conversation
openminddev
approved these changes
Jan 14, 2026
aydnOktay
pushed a commit
to aydnOktay/OM1
that referenced
this pull request
Jan 19, 2026
Co-authored-by: Nama Kamu <you@example.com> Co-authored-by: openminddev <147775420+openminddev@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds the missing
__init__docstring to theTurtleBot4Batteryclass located insrc/inputs/plugins/battery_turtlebot4.py.Details
The
__init__method lacked a docstring describing its purpose and parameters. This change adds a docstring following the NumPy style, clarifying:configparameter (TurtleBot4BatteryConfig) and its role.This change improves code readability and maintainability.