ros2 / ros2cli

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

Update ros2 param dump dosctring (`-h` option). #837

Closed mmmarinho closed 1 year ago

mmmarinho commented 1 year ago

As mentioned in #836 , this pull request aims to correct the ros2 param dump -h information.

Current doc

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

Proposed change

class DumpVerb(VerbExtension):
    """Show all of the parameters of a node in a YAML file format."""

Based on

The current docstring for ros2 param describe

https://github.com/ros2/ros2cli/blob/960962a142323c7a13c4ddef3a7e661d77905f93/ros2param/ros2param/verb/describe.py#L27-L28

mixed with the documentation at https://docs.ros.org/en/rolling/How-To-Guides/Using-ros2-param.html#ros2-param-dump

This command will print out all of the parameters on a particular node in a YAML file format.

I'd be glad to update this PR as needed.

fujitatomoya commented 1 year ago

@mmmarinho can you address DCO error? https://github.com/ros2/ros2cli/pull/837/checks?check_run_id=14811514019

mmmarinho commented 1 year ago

@mmmarinho can you address DCO error? https://github.com/ros2/ros2cli/pull/837/checks?check_run_id=14811514019

Sure thing, thanks for the info on how to do it.

fujitatomoya commented 1 year ago

CI:

fujitatomoya commented 1 year ago

@Mergifyio backport humble

mergify[bot] commented 1 year ago

backport humble

✅ Backports have been created

* [#840 Update ros2 param dump dosctring (`-h` option). (backport #837)](https://github.com/ros2/ros2cli/pull/840) has been created for branch `humble`
fujitatomoya commented 1 year ago

@Mergifyio backport iron

mergify[bot] commented 1 year ago

backport iron

✅ Backports have been created

* [#841 Update ros2 param dump dosctring (`-h` option). (backport #837)](https://github.com/ros2/ros2cli/pull/841) has been created for branch `iron`