diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Command_Templates.md | 19 | ||||
| -rw-r--r-- | docs/Config_Reference.md | 3 |
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/Command_Templates.md b/docs/Command_Templates.md index a5e3d323..f27f4a65 100644 --- a/docs/Command_Templates.md +++ b/docs/Command_Templates.md @@ -27,6 +27,25 @@ Note how the `gcode:` config option always starts at the beginning of the line and subsequent lines in the G-Code macro never start at the beginning. +### Add a description to your macro + +To help identify the functionality a short description can be added. +Add `description:` with a short text to describe the functionality. +Default is "G-Code macro" if not specified. +For example: + +``` +[gcode_macro blink_led] +description: Blink my_led one time +gcode: + SET_PIN PIN=my_led VALUE=1 + G4 P2000 + SET_PIN PIN=my_led VALUE=0 +``` + +This will be showing is you use the `HELP` command or use the autocomplete +function. + ### Save/Restore state for G-Code moves Unfortunately, the G-Code command language can be challenging to use. diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index e2930f1b..f09b90a9 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -1237,6 +1237,9 @@ G-Code macros (one may define any number of sections with a # commands. Care should be taken when overriding commands as it can # cause complex and unexpected results. The default is to not # override an existing G-Code command. +#description: G-Code macro +# This will add a short description used at the HELP command or while +# using the auto completion feature. Default "G-Code macro" ``` ## [delayed_gcode] |