ros2 / ros2cli

ROS 2 command line interface tools
Apache License 2.0
173 stars 159 forks source link

The `ros2 param dump` documentation (with `-h`) seems to be outdated. #836

Closed mmmarinho closed 1 year ago

mmmarinho commented 1 year ago

Documentation mismatch report

The ros2 param dump documentation (with -h) seems to be outdated.

Required Info:

Steps to reproduce the issue

ros2 param dump -h

Expected behavior

As far as I could tell from using the tool, the code, and the documentation about it, ros2 param dump no longer creates a file. Hence, we might benefit from a description of the current behavior of the tool, similar to the description in https://docs.ros.org/en/rolling/How-To-Guides/Using-ros2-param.html#ros2-param-dump

Print out all of the parameters on a particular node in a YAML file format.

Actual behavior

https://github.com/ros2/ros2cli/blob/960962a142323c7a13c4ddef3a7e661d77905f93/ros2param/ros2param/verb/dump.py#L31-L32

Dump the parameters of a node to a yaml file
clalancette commented 1 year ago

You are right. If you'd like to submit a pull request to fix it, we'd be happy to review it.

fujitatomoya commented 1 year ago

backport