Change docstring markdown code blocks to RST (#450) (#452)

Signed-off-by: Christophe Bedard <[email protected]>
(cherry picked from commit 9abb3be)

Co-authored-by: Christophe Bedard <[email protected]>

Author: mergify[bot]

launch_ros/launch_ros/actions/set_parameter.py

@@ -35,23 +35,25 @@ class SetParameter(Action):
     Action that sets a parameter in the current context.
 
     This parameter will be set in all the nodes launched in the same scope.
-    e.g.:
-    ```python3
+
+    For example:
+
+    .. code-block:: python
+
         LaunchDescription([
             ...,
             GroupAction(
                 actions = [
                     ...,
                     SetParameter(name='my_param', value='2'),
                     ...,
-                    Node(...),  // the param will be passed to this node
+                    Node(...),  # the param will be passed to this node
                     ...,
                 ]
             ),
-            Node(...),  // here it won't be passed, as it's not in the same scope
+            Node(...),  # here it won't be passed, as it's not in the same scope
             ...
         ])
-    ```
     """
 
     def __init__(

launch_ros/launch_ros/actions/set_parameters_from_file.py

@@ -29,33 +29,34 @@ class SetParametersFromFile(Action):
     """
     Action that sets parameters for all nodes in scope based on a given yaml file.
 
-    e.g.
-    ```python3
+    For example:
+
+    .. code-block:: python
+
         LaunchDescription([
             ...,
             GroupAction(
                 actions = [
                     ...,
                     SetParametersFromFile('path/to/file.yaml'),
                     ...,
-                    Node(...),  // the params will be passed to this node
+                    Node(...),  # the params will be passed to this node
                     ...,
                 ]
             ),
-            Node(...),  // here it won't be passed, as it's not in the same scope
+            Node(...),  # here it won't be passed, as it's not in the same scope
             ...
         ])
-    ```
-    ```xml
-    <launch>
-        <group>
-            <set_parameters_from_file filename='/path/to/file.yaml'/>
-            <node .../>    // Node in scope, params will be passed
-        </group>
-        <node .../>  // Node not in scope, params won't be passed
-    </launch>
 
-    ```
+    .. code-block:: xml
+
+        <launch>
+            <group>
+                <set_parameters_from_file filename='/path/to/file.yaml'/>
+                <node .../>  <!-- Node in scope, params will be passed -->
+            </group>
+            <node .../>  <!-- Node not in scope, params won't be passed -->
+        </launch>
     """
 
     def __init__(

launch_ros/launch_ros/actions/set_remap.py

@@ -34,23 +34,25 @@ class SetRemap(Action):
 
     This remapping rule will be passed to all the nodes launched in the same scope, overriding
     the ones specified in the `Node` action constructor.
-    e.g.:
-    ```python3
+
+    For example:
+
+    .. code-block:: python
+
         LaunchDescription([
             ...,
             GroupAction(
                 actions = [
                     ...,
                     SetRemap(src='asd', dst='bsd'),
                     ...,
-                    Node(...),  // the remap rule will be passed to this node
+                    Node(...),  # the remap rule will be passed to this node
                     ...,
                 ]
             ),
-            Node(...),  // here it won't be passed, as it's not in the same scope
+            Node(...),  # here it won't be passed, as it's not in the same scope
             ...
         ])
-    ```
     """
 
     def __init__(

launch_ros/launch_ros/utilities/namespace_utils.py

@@ -47,24 +47,24 @@ def prefix_namespace(
         `ns` prefixed with `base_ns`.
         In all cases, trailing `/` are stripped from the result.
 
-    ## Examples:
+    For example:
 
-    ```python3
-    combined_ns = prefix_namespace('my_ns', 'original_ns')
-    assert combined_ns == 'my_ns/original_ns'
+    .. code-block:: python
 
-    combined_ns = prefix_namespace('/my_ns', 'original_ns')
-    assert combined_ns == '/my_ns/original_ns'
+        combined_ns = prefix_namespace('my_ns', 'original_ns')
+        assert combined_ns == 'my_ns/original_ns'
 
-    combined_ns = prefix_namespace('my_ns', '/original_ns')
-    assert combined_ns == '/original_ns'
+        combined_ns = prefix_namespace('/my_ns', 'original_ns')
+        assert combined_ns == '/my_ns/original_ns'
 
-    combined_ns = prefix_namespace(None, 'original_ns')
-    assert combined_ns == 'original_ns'
+        combined_ns = prefix_namespace('my_ns', '/original_ns')
+        assert combined_ns == '/original_ns'
 
-    combined_ns = prefix_namespace('my_ns', None)
-    assert combined_ns == 'my_ns'
-    ```
+        combined_ns = prefix_namespace(None, 'original_ns')
+        assert combined_ns == 'original_ns'
+
+        combined_ns = prefix_namespace('my_ns', None)
+        assert combined_ns == 'my_ns'
     """
     combined_ns: Optional[Text] = None
     if base_ns is not None or ns is not None: