aboutsummaryrefslogtreecommitdiffstats
path: root/config/example-extras.cfg
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2018-09-26 08:25:44 -0400
committerKevin O'Connor <kevin@koconnor.net>2018-09-26 08:25:44 -0400
commitcf79b3c34223b769f14dbf80f99216d59da4c7c7 (patch)
tree11c482399b2f33da1cb8fc367f41bf99cbcc5472 /config/example-extras.cfg
parent439f6684bee4f4cd884e24cd6f5409632c9ab2f9 (diff)
downloadkutter-cf79b3c34223b769f14dbf80f99216d59da4c7c7.tar.gz
kutter-cf79b3c34223b769f14dbf80f99216d59da4c7c7.tar.xz
kutter-cf79b3c34223b769f14dbf80f99216d59da4c7c7.zip
config: Note gcode_macro string formatting in example-extras.cfg
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'config/example-extras.cfg')
-rw-r--r--config/example-extras.cfg8
1 files changed, 6 insertions, 2 deletions
diff --git a/config/example-extras.cfg b/config/example-extras.cfg
index 9eed2993..8b1cad33 100644
--- a/config/example-extras.cfg
+++ b/config/example-extras.cfg
@@ -970,8 +970,12 @@
#[gcode_macro my_cmd]
#gcode:
# A list of G-Code commands (one per line; subsequent lines
-# indented) to execute in place of "my_cmd". This parameter must be
-# provided.
+# indented) to execute in place of "my_cmd". This parameter is
+# evaluated using Python "string format syntax" with the command
+# parameters as named arguments. For example, if one were to define
+# a macro MY_DELAY with gcode "G4 P{DELAY}" then the command
+# "MY_DELAY DELAY=100" would evaluate to "G4 P100". This parameter
+# must be provided.
# Replicape support - see the generic-replicape.cfg file for further