From cf79b3c34223b769f14dbf80f99216d59da4c7c7 Mon Sep 17 00:00:00 2001
From: Kevin O'Connor <kevin@koconnor.net>
Date: Wed, 26 Sep 2018 08:25:44 -0400
Subject: [PATCH] config: Note gcode_macro string formatting in
example-extras.cfg
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
---
config/example-extras.cfg | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/config/example-extras.cfg b/config/example-extras.cfg
index 9eed29931..8b1cad339 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