From 8cd7d625dc06811a588f5f79174bcf11393901a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Fr=C3=B6hlich?= Date: Mon, 7 Aug 2023 07:36:08 +0200 Subject: [PATCH 1/3] Update description of view_controller_chains --- ros2controlcli/doc/userdoc.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/ros2controlcli/doc/userdoc.rst b/ros2controlcli/doc/userdoc.rst index dba173cfbf..12d19e6d7d 100644 --- a/ros2controlcli/doc/userdoc.rst +++ b/ros2controlcli/doc/userdoc.rst @@ -269,3 +269,13 @@ view_controller_chains usage: ros2 view_controller_chains Creates a graphviz image from loaded controllers. + + options: + -h, --help show this help message and exit + --spin-time SPIN_TIME + Spin time in seconds to wait for discovery (only applies when not using an already running daemon) + -s, --use-sim-time Enable ROS simulation time + -c CONTROLLER_MANAGER, --controller-manager CONTROLLER_MANAGER + Name of the controller manager ROS node + --include-hidden-nodes + Consider hidden nodes as well From be4237a8e46374ddedab1e7478df75b2ae7200f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Fr=C3=B6hlich?= Date: Mon, 7 Aug 2023 07:55:44 +0200 Subject: [PATCH 2/3] Add info where the pdf is saved to --- ros2controlcli/doc/userdoc.rst | 2 +- ros2controlcli/ros2controlcli/verb/view_controller_chains.py | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/ros2controlcli/doc/userdoc.rst b/ros2controlcli/doc/userdoc.rst index 12d19e6d7d..5880c054cb 100644 --- a/ros2controlcli/doc/userdoc.rst +++ b/ros2controlcli/doc/userdoc.rst @@ -268,7 +268,7 @@ view_controller_chains $ ros2 control view_controller_chains -h usage: ros2 view_controller_chains - Creates a graphviz image from loaded controllers. + Generates a diagram of the loaded chained controllers into /tmp/controller_diagram.gv.pdf options: -h, --help show this help message and exit diff --git a/ros2controlcli/ros2controlcli/verb/view_controller_chains.py b/ros2controlcli/ros2controlcli/verb/view_controller_chains.py index fbd999192e..e825ab7457 100644 --- a/ros2controlcli/ros2controlcli/verb/view_controller_chains.py +++ b/ros2controlcli/ros2controlcli/verb/view_controller_chains.py @@ -195,7 +195,9 @@ def parse_response(list_controllers_response, list_hardware_response, visualize= class ViewControllerChainsVerb(VerbExtension): - """Generates a diagram of the loaded chained controllers.""" + """ + Generates a diagram of the loaded chained controllers into /tmp/controller_diagram.gv.pdf + """ def add_arguments(self, parser, cli_name): add_arguments(parser) From 352fea220c6ee76fb9364171c3ef10a94dce98ab Mon Sep 17 00:00:00 2001 From: Christoph Froehlich Date: Mon, 7 Aug 2023 09:09:13 +0000 Subject: [PATCH 3/3] Reformat docstring --- ros2controlcli/ros2controlcli/verb/view_controller_chains.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/ros2controlcli/ros2controlcli/verb/view_controller_chains.py b/ros2controlcli/ros2controlcli/verb/view_controller_chains.py index e825ab7457..f838a96e1c 100644 --- a/ros2controlcli/ros2controlcli/verb/view_controller_chains.py +++ b/ros2controlcli/ros2controlcli/verb/view_controller_chains.py @@ -195,9 +195,7 @@ def parse_response(list_controllers_response, list_hardware_response, visualize= class ViewControllerChainsVerb(VerbExtension): - """ - Generates a diagram of the loaded chained controllers into /tmp/controller_diagram.gv.pdf - """ + """Generates a diagram of the loaded chained controllers into /tmp/controller_diagram.gv.pdf.""" def add_arguments(self, parser, cli_name): add_arguments(parser)