Skip to content

Commit 9db3fda

Browse files
authored
rename RosTimer -> ROSTimer and PushRosNamepsace -> PushROSNamespace (ros2#3038)
* rename RosTimer -> ROSTimer and PushRosNamepsace -> PushROSNamespace Signed-off-by: William Woodall <[email protected]> * not about changed class names Signed-off-by: William Woodall <[email protected]> * reword Signed-off-by: William Woodall <[email protected]> Signed-off-by: William Woodall <[email protected]>
1 parent 8cee5bb commit 9db3fda

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

source/How-To-Guides/Launch-file-different-formats.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Each launch file performs the following actions:
4545
from launch.substitutions import LaunchConfiguration
4646
from launch.substitutions import TextSubstitution
4747
from launch_ros.actions import Node
48-
from launch_ros.actions import PushRosNamespace
48+
from launch_ros.actions import PushROSNamespace
4949
5050
5151
def generate_launch_description():
@@ -75,7 +75,7 @@ Each launch file performs the following actions:
7575
launch_include_with_namespace = GroupAction(
7676
actions=[
7777
# push_ros_namespace to set namespace of included nodes
78-
PushRosNamespace('chatter_ns'),
78+
PushROSNamespace('chatter_ns'),
7979
IncludeLaunchDescription(
8080
PythonLaunchDescriptionSource(
8181
os.path.join(

source/Releases/Release-Iron-Irwini.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,18 @@ Related PR: `ros2/ros2cli#749 <https://github.com/ros2/ros2cli/pull/749>`_
5555
Changes since the Humble release
5656
----------------------------------
5757

58-
To come.
58+
``launch_ros``
59+
^^^^^^^^^^^^^^
60+
61+
Renamed classes which used ``Ros`` in the name to use ``ROS`` in line with PEP8
62+
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
63+
64+
Classes that were changed:
65+
66+
* ``launch.actions.RosTimer`` -> ``launch.actions.ROSTimer``
67+
* ``launch.actions.PushRosNamespace`` -> ``launch.actions.PushROSNamespace``
68+
69+
The old class names are still there, but will be deprecated.
5970

6071
Known Issues
6172
------------

source/Tutorials/Intermediate/Launch/Using-ROS2-Launch-For-Large-Projects.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ Unique namespaces allow the system to start two similar nodes without node name
280280
namespace='turtlesim2',
281281
282282
However, if the launch file contains a large number of nodes, defining namespaces for each of them can become tedious.
283-
To solve that issue, the ``PushRosNamespace`` action can be used to define the global namespace for each launch file description.
283+
To solve that issue, the ``PushROSNamespace`` action can be used to define the global namespace for each launch file description.
284284
Every nested node will inherit that namespace automatically.
285285

286286
To do that, firstly, we need to remove the ``namespace='turtlesim2'`` line from the ``turtlesim_world_2.launch.py`` file.
@@ -289,7 +289,7 @@ Afterwards, we need to update the ``launch_turtlesim.launch.py`` to include the
289289
.. code-block:: Python
290290
291291
from launch.actions import GroupAction
292-
from launch_ros.actions import PushRosNamespace
292+
from launch_ros.actions import PushROSNamespace
293293
294294
...
295295
turtlesim_world_2 = IncludeLaunchDescription(
@@ -299,7 +299,7 @@ Afterwards, we need to update the ``launch_turtlesim.launch.py`` to include the
299299
)
300300
turtlesim_world_2_with_namespace = GroupAction(
301301
actions=[
302-
PushRosNamespace('turtlesim2'),
302+
PushROSNamespace('turtlesim2'),
303303
turtlesim_world_2,
304304
]
305305
)

0 commit comments

Comments
 (0)