Skip to content

Commit 0a968e8

Browse files
committed
Complete yaml extension docs
1 parent ac160ae commit 0a968e8

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/source/concept-slam-configuration-file.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ in either absolute path, or relative to the current YAML file being parsed.
5252
- type: CLASS_NAME1 # mandatory
5353
#...
5454
params: # Other module-specific parameters
55-
$include{$(mola-dir module-name)/params/xxxx.yaml}
55+
$include{$(ros2 pkg prefix mola_lidar_odometry)/share/xxx/xxxx.yaml}
5656
config:
5757
$include{params/xxxx.yaml}
5858
@@ -69,3 +69,11 @@ Replace output of external process: ``$(cmd)``
6969
The pattern ``$(cmd arg1 arg2...)`` is replaced by the console output of running
7070
the given command with the given arguments. See for example its usage together
7171
with ``$include{xxx}`` above.
72+
73+
Mathematical formulas : ``$f{xxx}``
74+
-----------------------------------------------
75+
The pattern ``$f{expr}`` can be used to indicate mathematical expressions.
76+
The `ExprTk library <https://github.com/ArashPartow/exprtk>`_ is used
77+
(via `mrpt-expr <https://docs.mrpt.org/reference/latest/group_mrpt_expr_grp.html>`_),
78+
so refer to their documentation for built-in functions and syntax.
79+
User-defined variables can be used, depending on the context of the YAML file being parsed.

0 commit comments

Comments
 (0)