Skip to content

Commit 7ba272c

Browse files
authored
Enable document generation using rosdoc2 (#811)
* Fix warnings for ros2component, ros2doctor, ros2interface, and ros2node Signed-off-by: Yadunund <[email protected]>
1 parent 0c6f197 commit 7ba272c

File tree

5 files changed

+9
-5
lines changed

5 files changed

+9
-5
lines changed

ros2cli/ros2cli/node/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414
from rclpy.node import HIDDEN_NODE_PREFIX
15-
NODE_NAME_PREFIX = HIDDEN_NODE_PREFIX + 'ros2cli'
15+
NODE_NAME_PREFIX = str(HIDDEN_NODE_PREFIX) + 'ros2cli'

ros2component/ros2component/api/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ def get_components_in_container(*, node, remote_container_node_name):
7575
:param node: an `rclpy.Node` instance.
7676
:param remote_container_node_names: of the container node to inspect.
7777
:return: a tuple with either a truthy boolean and a list of `ComponentInfo`
78-
instances containing the unique id and name of each component or a falsy
79-
boolean and a reason string in case of error.
78+
instances containing the unique id and name of each component or a falsy
79+
boolean and a reason string in case of error.
8080
"""
8181
return get_components_in_containers(
8282
node=node, remote_containers_node_names=[remote_container_node_name]
@@ -92,8 +92,8 @@ def get_components_in_containers(*, node, remote_containers_node_names):
9292
:param node: an `rclpy.Node` instance.
9393
:param remote_container_node_names: of the container nodes to inspect.
9494
:return: a dict of tuples, with either a truthy boolean and a list of `ComponentInfo`
95-
instances containing the unique id and name of each component or a falsy boolean and
96-
a reason string in case of error, per container node.
95+
instances containing the unique id and name of each component or a falsy boolean and
96+
a reason string in case of error, per container node.
9797
"""
9898
def list_components(node, remote_container_node_name):
9999
list_nodes_client = node.create_client(

ros2doctor/package.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
<exec_depend>python3-rosdistro-modules</exec_depend>
2525
<exec_depend>rclpy</exec_depend>
2626
<exec_depend>ros_environment</exec_depend>
27+
<exec_depend>std_msgs</exec_depend>
2728

2829
<test_depend>ament_copyright</test_depend>
2930
<test_depend>ament_flake8</test_depend>

ros2interface/package.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
<depend>ros2cli</depend>
2222

2323
<exec_depend>ament_index_python</exec_depend>
24+
<exec_depend>rosidl_adapter</exec_depend>
2425
<exec_depend>rosidl_runtime_py</exec_depend>
2526

2627
<test_depend>ament_copyright</test_depend>

ros2node/package.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919

2020
<depend>ros2cli</depend>
2121

22+
<exec_depend>rclpy</exec_depend>
23+
2224
<test_depend>ament_copyright</test_depend>
2325
<test_depend>ament_flake8</test_depend>
2426
<test_depend>ament_pep257</test_depend>

0 commit comments

Comments
 (0)