Skip to content

docs(providers): improve ROS2PublisherProvider documentation#1496

Merged
openminddev merged 4 commits intoOpenMind:mainfrom
wantingNBi:docs/ros2-publisher-init-docs
Jan 19, 2026
Merged

docs(providers): improve ROS2PublisherProvider documentation#1496
openminddev merged 4 commits intoOpenMind:mainfrom
wantingNBi:docs/ros2-publisher-init-docs

Conversation

@wantingNBi
Copy link
Copy Markdown
Contributor

Documented the __init__ parameters for ROS2PublisherProvider class.

  • Added complete class-level documentation with Attributes section
  • Added Parameters documentation for topic parameter in __init__ method
  • Added Notes section explaining the initialization process
  • Follows NumPy style docstring format consistent with other Provider classes

The topic parameter specifies the ROS 2 topic name for publishing String messages, with a default value of "speak_topic" and queue size of 10.

@wantingNBi wantingNBi requested review from a team as code owners January 15, 2026 20:04
@github-actions github-actions Bot added robotics Robotics code changes python Python code labels Jan 15, 2026
wantingNBi and others added 3 commits January 18, 2026 21:16
Cleaned up the class and constructor docstrings by removing detailed attribute and initialization process documentation, making the comments more concise and focused.
@openminddev openminddev merged commit 5d0e52c into OpenMind:main Jan 19, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

python Python code robotics Robotics code changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants