Skip to content
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

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

Merged
merged 1 commit into from Jul 6, 2023
Merged

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

merged 1 commit into from Jul 6, 2023

Conversation

mmmarinho
Copy link
Contributor

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

Current doc

ros2cli/ros2param/ros2param/verb/dump.py

Lines 31 to 32 in 960962a

class DumpVerb(VerbExtension):
"""Dump the parameters of a node to a yaml file."""

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

ros2cli/ros2param/ros2param/verb/describe.py

Lines 27 to 28 in 960962a

class DescribeVerb(VerbExtension):
"""Show descriptive information about declared parameters."""

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
Copy link
Collaborator

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

@mmmarinho
Update ros2 param dump dosctring.
e6c6ace 
"""Dump the parameters of a node to a yaml file.""" -> """Show all of the parameters of a node in a YAML file format."""

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

Signed-off-by: Murilo M. Marinho <murilomarinho@ieee.org>
@mmmarinho
Copy link
Contributor Author

@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
Copy link
Collaborator

CI:

  • Linux Build Status
  • Linux-aarch64 Build Status
  • Windows Build Status

@clalancette clalancette merged commit ef5d811 into ros2:rolling Jul 6, 2023
2 of 3 checks passed
@fujitatomoya
Copy link
Collaborator

@Mergifyio backport humble

@mergify
Copy link

mergify bot commented Jul 9, 2023 •
edited

backport humble

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Jul 9, 2023
@mmmarinho @mergify
Update ros2 param dump dosctring. (#837)
f956aa3 
"""Dump the parameters of a node to a yaml file.""" -> """Show all of the parameters of a node in a YAML file format."""

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

Signed-off-by: Murilo M. Marinho <murilomarinho@ieee.org>
(cherry picked from commit ef5d811)
@mergify mergify bot mentioned this pull request Jul 9, 2023
Merged
fujitatomoya pushed a commit that referenced this pull request Jul 10, 2023
@mergify @mmmarinho
Update ros2 param dump dosctring. (#837) (#840)
1580a03 
"""Dump the parameters of a node to a yaml file.""" -> """Show all of the parameters of a node in a YAML file format."""

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

Signed-off-by: Murilo M. Marinho <murilomarinho@ieee.org>
(cherry picked from commit ef5d811)

Co-authored-by: Murilo M Marinho <46012516+mmmarinho@users.noreply.github.com>
@fujitatomoya
Copy link
Collaborator

@Mergifyio backport iron

@mergify
Copy link

mergify bot commented Jul 10, 2023 •
edited

backport iron

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Jul 10, 2023
@mmmarinho @mergify
Update ros2 param dump dosctring. (#837)
dec20b7 
"""Dump the parameters of a node to a yaml file.""" -> """Show all of the parameters of a node in a YAML file format."""

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

Signed-off-by: Murilo M. Marinho <murilomarinho@ieee.org>
(cherry picked from commit ef5d811)
@mergify mergify bot mentioned this pull request Jul 10, 2023
Merged
fujitatomoya pushed a commit that referenced this pull request Jul 10, 2023
@mergify @mmmarinho
Update ros2 param dump dosctring. (#837) (#841)
1e8f7c1 
"""Dump the parameters of a node to a yaml file.""" -> """Show all of the parameters of a node in a YAML file format."""

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

Signed-off-by: Murilo M. Marinho <murilomarinho@ieee.org>
(cherry picked from commit ef5d811)

Co-authored-by: Murilo M Marinho <46012516+mmmarinho@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@clalancette clalancette clalancette approved these changes

@fujitatomoya fujitatomoya fujitatomoya approved these changes

@audrow audrow Awaiting requested review from audrow audrow is a code owner

@gbiggs gbiggs Awaiting requested review from gbiggs gbiggs is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@mmmarinho @fujitatomoya @clalancette