Skip to content

Commit 8796058

Browse files
committed
Run pre-commits and fix CI
Signed-off-by: methylDragon <[email protected]>
1 parent 5802976 commit 8796058

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

Diff for: doc/how_to_guides/trajectory_cache/src/trajectory_cache_demo.cpp

+4-4
Original file line numberDiff line numberDiff line change
@@ -56,20 +56,20 @@
5656
*
5757
* NOTE:
5858
* Tutorial notes will be commented like this block!
59-
*
59+
*
6060
* PRE-REQUISITES
6161
* ^^^^^^^^^^^^^^
6262
* This tutorial assumes knowledge of the MoveGroupInterface.
6363
*
6464
* INTERACTIVITY
6565
* ^^^^^^^^^^^^^
6666
* This demo has four phases that can be advanced using the `rviz_visual_tools` dialog box.
67-
*
67+
*
6868
* 1. Plan and cache (no pruning)
6969
* 2. Plan and cache (with pruning)
7070
* 3. Fetch from cache and execute (while still planning and caching with pruning)
7171
* 4. Fetch from cache and execute, except with large start tolerances
72-
*
72+
*
7373
* This tutorial also supports "reconfigurable" parameters!:
7474
*
7575
* You can adjust them with:
@@ -657,7 +657,7 @@ int main(int argc, char** argv)
657657

658658
/** [TUTORIAL NOTE]
659659
* This demo has four phases that can be advanced using the `rviz_visual_tools` dialog box.
660-
*
660+
*
661661
* 1. Plan and cache (no pruning)
662662
* - Showcases basic cache functionality.
663663
* 2. Plan and cache (with pruning)

Diff for: doc/how_to_guides/trajectory_cache/trajectory_cache_tutorial.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Furthermore, the cache supports pruning and ranking of fetched trajectories, wit
1010

1111
<video width="450px" controls="true" autoplay="true" loop="true">
1212
<source src="../../../_static/videos/trajectory_cache/01_cache_and_execute_loop.webm" type="video/webm">
13-
Introduction video showing the trajectory cache working.
13+
Introduction video showing the trajectory cache working.
1414
</video>
1515

1616
For more info, please see the :moveit_codedir:`package README <moveit_ros/trajectory_cache/README.md>`.
@@ -118,7 +118,7 @@ This demo has four phases that can be advanced using the ``rviz_visual_tools`` d
118118
3. Fetch from cache and execute (while still planning and caching with pruning)
119119
4. Fetch from cache and execute, except with large start tolerances
120120

121-
Additionally, the `demo source code itself <how_to_guides/trajectory_cache/src/trajectory_cache_demo.cpp>`_ is heavily annotated with comments and tutorial notes, should you wish to inspect the code and dive deeper.
121+
Additionally, the :codedir:`demo source code itself <how_to_guides/trajectory_cache/src/trajectory_cache_demo.cpp>` is heavily annotated with comments and tutorial notes, should you wish to inspect the code and dive deeper.
122122

123123
Pre-Requisites
124124
++++++++++++++
@@ -147,14 +147,14 @@ Click ``next`` on the rviz window to advance the demo.
147147
.. note::
148148
Sometimes a randomly generated demo goal pose is unreachable (or the ``move_group`` fails to initialize properly).
149149
If this happens, the demo will halt in the first phase due to a failed planning call or other issue.
150-
150+
151151
Just restart the demo, which will generate new demo goal poses, and resolve the issue.
152152

153153
Configuring the Demo
154154
++++++++++++++++++++
155155

156156
Additionally, the demo's launch file exposes launch arguments that allows you to change many aspects of the demo.
157-
Look at the `demo's launch file <how_to_guides/trajectory_cache/launch/trajectory_cache_demo.launch.py>`_ for the full list of configurable launch arguments.
157+
Look at the :codedir:`demo's launch file <how_to_guides/trajectory_cache/launch/trajectory_cache_demo.launch.py>` for the full list of configurable launch arguments.
158158

159159
For example, you can specify a disk path for the cache to be saved to and loaded from, instead of memory:
160160

@@ -192,7 +192,7 @@ To interpret the visualization:
192192

193193
.. note::
194194
You may note how in the visualization that the green trajectory (the best trajectory) appears to be much more optimal than some of the other candidate plans.
195-
195+
196196
And furthermore, that most of the time, the fetch times are shorter than the planning times, even in this no-obstruction case, showing how the cache is saving the process planning time.
197197

198198
The default cache insert policy inserts a cache plan only if it is the best seen (in terms of execution time) so far.
@@ -247,7 +247,7 @@ Observe that the executed trajectory is always locked to the best matching traje
247247
.. image:: images/demo_CacheAndExecute_best_trajectory.png
248248
:width: 450px
249249

250-
Furthermore, notice that the set of matchable trajectories (indicated by white) is an even more constrained set from
250+
Furthermore, notice that the set of matchable trajectories (indicated by white) is an even more constrained set from
251251
This shows that the cache is partitionable and able to filter out unmatchable entries by nature of the constraints that key them.
252252

253253
To interpret the visualization, with the same legend as before:
@@ -311,7 +311,7 @@ Customizable Behavior
311311
+++++++++++++++++++++
312312

313313
It is possible to extend the cache to key on custom user-defined features, and also to change the cache insertion, sorting, and pruning logic.
314-
You do this by implementing the features and cache insert policy interfaces, then feeding them into the
314+
You do this by implementing the features and cache insert policy interfaces, then feeding them into the
315315

316316
For example, you may decide to write your own feature extractor to key the cache, and decide when to insert or prune a cache entry on features such as:
317317

@@ -322,4 +322,4 @@ For example, you may decide to write your own feature extractor to key the cache
322322
See:
323323

324324
- :moveit_codedir:`package README <moveit_ros/trajectory_cache/include/moveit/trajectory_cache/features/features_interface.hpp>`
325-
- :moveit_codedir:`package README <moveit_ros/trajectory_cache/include/moveit/trajectory_cache/cache_insert_policies/cache_insert_policy_interface.hpp>`
325+
- :moveit_codedir:`package README <moveit_ros/trajectory_cache/include/moveit/trajectory_cache/cache_insert_policies/cache_insert_policy_interface.hpp>`

0 commit comments

Comments
 (0)