config: Be clear that multi-line parameters must use indentation

Also, be clear that probe points are nozzle coordinates (not probe
coordinates).

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>

1 files changed, 44 insertions, 35 deletions

diff --git a/config/example-extras.cfg b/config/example-extras.cfg
index 5413ee18..e1caf64d 100644
--- a/config/example-extras.cfg
+++ b/config/example-extras.cfg
@@ -29,14 +29,14 @@
 #speed: 5.0
 #   Speed (in mm/s) of the Z axis when probing. The default is 5mm/s.
 #activate_gcode:
-#   A list of G-Code commands (one per line) to execute prior to each
-#   probe attempt. This may be useful if the probe needs to be
-#   activated in some way. The default is to not run any special
-#   G-Code commands on activation.
+#   A list of G-Code commands (one per line; subsequent lines
+#   indented) to execute prior to each probe attempt. This may be
+#   useful if the probe needs to be activated in some way. The default
+#   is to not run any special G-Code commands on activation.
 #deactivate_gcode:
-#   A list of G-Code commands (one per line) to execute after each
-#   probe attempt completes. The default is to not run any special
-#   G-Code commands on deactivation.
+#   A list of G-Code commands (one per line; subsequent lines
+#   indented) to execute after each probe attempt completes. The
+#   default is to not run any special G-Code commands on deactivation.
 
 
 # Bed tilt compensation. One may define a [bed_tilt] config section to
@@ -52,9 +52,11 @@
 # g-code command that may be used to calibrate appropriate x and y
 # adjustment parameters.
 #points:
-#    A newline separated list of X,Y points that should be probed
-#    during a BED_TILT_CALIBRATE command. The default is to not enable
-#    the command.
+#    A list of X,Y coordinates (one per line; subsequent lines
+#    indented) that should be probed during a BED_TILT_CALIBRATE
+#    command. Specify coordinates of the nozzle and be sure the probe
+#    is above the bed at the given nozzle coordinates. The default is
+#    to not enable the command.
 #speed: 50
 #   The speed (in mm/s) of non-probing moves during the
 #   calibration. The default is 50.
@@ -149,13 +151,16 @@
 # extended G-Code command becomes available.
 #[z_tilt]
 #z_positions:
-#    A newline separated list of X,Y coordinates describing the
-#    location of each Z stepper. The first entry corresponds to
-#    stepper_z, the second to stepper_z1, the third to stepper_z2,
-#    etc. This parameter must be provided.
+#    A list of X,Y coordinates (one per line; subsequent lines
+#    indented) describing the location of each Z stepper. The first
+#    entry corresponds to stepper_z, the second to stepper_z1, the
+#    third to stepper_z2, etc. This parameter must be provided.
 #points:
-#    A newline separated list of X,Y points that should be probed
-#    during a Z_TILT_ADJUST command. This parameter must be provided.
+#    A list of X,Y coordinates (one per line; subsequent lines
+#    indented) that should be probed during a Z_TILT_ADJUST
+#    command. Specify coordinates of the nozzle and be sure the probe
+#    is above the bed at the given nozzle coordinates. This parameter
+#    must be provided.
 #speed: 50
 #   The speed (in mm/s) of non-probing moves during the calibration.
 #   The default is 50.
@@ -186,17 +191,18 @@
 #   should specify "shared_heater: extruder3". The default is to not
 #   reuse an existing heater.
 #deactivate_gcode:
-#   A list of G-Code commands (one per line) to execute on a G-Code
-#   tool change command (eg, "T1") that deactivates this extruder and
-#   activates some other extruder. It only makes sense to define this
-#   section on multi-extruder printers. The default is to not run any
-#   special G-Code commands on deactivation.
+#   A list of G-Code commands (one per line; subsequent lines
+#   indented) to execute on a G-Code tool change command (eg, "T1")
+#   that deactivates this extruder and activates some other
+#   extruder. It only makes sense to define this section on
+#   multi-extruder printers. The default is to not run any special
+#   G-Code commands on deactivation.
 #activate_gcode:
-#   A list of G-Code commands (one per line) to execute on a G-Code
-#   tool change command (eg, "T0") that activates this extruder. It
-#   only makes sense to define this section on multi-extruder
-#   printers. The default is to not run any special G-Code commands on
-#   activation.
+#   A list of G-Code commands (one per line; subsequent lines
+#   indented) to execute on a G-Code tool change command (eg, "T0")
+#   that activates this extruder. It only makes sense to define this
+#   section on multi-extruder printers. The default is to not run any
+#   special G-Code commands on activation.
 
 
 # Support for cartesian printers with dual carriages on a single
@@ -252,8 +258,9 @@
 # explicit idle_timeout config section to change the default settings.
 #[idle_timeout]
 #gcode:
-#   A list of G-Code commands (one per line) to execute on an idle
-#   timeout. The default is to run "M84".
+#   A list of G-Code commands (one per line; subsequent lines
+#   indented) to execute on an idle timeout. The default is to run
+#   "M84".
 #timeout: 600
 #   Idle time (in seconds) to wait before running the above G-Code
 #   commands. The default is 600 seconds.
@@ -661,11 +668,12 @@
 # home the machine.
 #[homing_override]
 #gcode:
-#   A list of G-Code commands (one per line) to execute in place of
-#   G28 commands found in the normal g-code input. If a G28 is
-#   contained in this list of commands then it will invoke the normal
-#   homing procedure for the printer. The commands listed here must
-#   home all axes. This parameter must be provided.
+#   A list of G-Code commands (one per line; subsequent lines
+#   indented) to execute in place of G28 commands found in the normal
+#   g-code input. If a G28 is contained in this list of commands then
+#   it will invoke the normal homing procedure for the printer. The
+#   commands listed here must home all axes. This parameter must be
+#   provided.
 #axes: xyz
 #   The axes to override. For example, if this is set to "z" then the
 #   override script will only be run when the z axis is homed (eg, via
@@ -837,8 +845,9 @@
 # "gcode_macro" prefix).
 #[gcode_macro my_cmd]
 #gcode:
-#   A list of G-Code commands (one per line) to execute in place of
-#   "my_cmd". This parameter must be provided.
+#   A list of G-Code commands (one per line; subsequent lines
+#   indented) to execute in place of "my_cmd". This parameter must be
+#   provided.
 
 
 # Replicape support - see the generic-replicape.cfg file for further