docs: Syntactic pleasantries.

docs/src/code/code-notes.adoc

@@ -745,7 +745,7 @@ nearly identical for every parameter.
 
 == Backlash and Screw Error Compensation
 
- + FIXME Backlash and Screw Error Compensation
+FIXME Backlash and Screw Error Compensation
 
 == Task controller (EMCTASK)
 
@@ -773,7 +773,7 @@ iocontrol main loop process:
 
 == User Interfaces
 
-  FIXME User Interfaces
+FIXME User Interfaces
 
 == libnml Introduction
 
@@ -1000,13 +1000,13 @@ unclear from the NIST documents. Only INF and positive values are
 mentioned. However, buried in the source code of rcslib, it is apparent
 that the following applies:
 
-timeout > 0 Blocking access until the timeout interval is reached or
+timeout > 0:: Blocking access until the timeout interval is reached or
 access to the buffer is available.
 
-timeout = 0 Access to the buffer is only possible if no other process
+timeout = 0:: Access to the buffer is only possible if no other process
 is reading or writing at the time.
 
-timeout < 0 or INF Access is blocked until the buffer is available.
+timeout < 0 or INF:: Access is blocked until the buffer is available.
 
 == NML base class
 
@@ -1095,7 +1095,7 @@ example is called EMC_IO_GENERIC (inherits EMC_IO_CMD_MSG (inherits
 RCS_CMD_MSG)))
 
 . add the definition of the EMC_IO_GENERIC class to emc2/src/emc/nml_intf/emc.hh
-. add the type define: #define EMC_IO_GENERIC_TYPE ((NMLTYPE) 1605) +
+. add the type define: #define EMC_IO_GENERIC_TYPE \((NMLTYPE) 1605) +
 .. (I chose 1605, because it was available) to emc2/src/emc/nml_intf/emc.hh
 . add case EMC_IO_GENERIC_TYPE to emcFormat in emc2/src/emc/nml_intf/emc.cc
 . add case EMC_IO_GENERIC_TYPE to emc_symbol_lookup in emc2/src/emc/nml_intf/emc.cc

docs/src/gcode/overview.adoc

@@ -937,13 +937,14 @@ It is an error if:
 == Modal Groups
 
 (((Modal Groups)))
- commands are arranged in sets called 'modal groups', and only
-one member of a modal group may be in force at any given time. In
-general, a modal group contains commands for which it is logically
+Commands are arranged in sets called 'modal groups', and only
+one member of a modal group may be in force at any given time.
+In general, a modal group contains commands for which it is logically
 impossible for two members to be in effect at the same time - like
-measure in inches vs. measure in millimeters. A machining center may be
-in many modes at the same time, with one mode from each modal group
-being in effect. The modal groups are shown in the following Table.
+measure in inches versus measure in millimeters.
+A machining center may be in many modes at the same time,
+with one mode from each modal group being in effect.
+The modal groups are shown in the following Table.
 
 [[cap:modal-groups]]
 .G-code Modal Groups(((Modal Groups: G-codes)))
@@ -1222,6 +1223,7 @@ position of each item on the line, but by the following list:
 == G-code Best Practices
 
 (((G-code Best Practices)))
+
 .Use an appropriate decimal precision
 Use at least 3 digits after the decimal when milling in millimeters,
 and at least 4 digits after the decimal when milling in inches.

docs/src/gcode/tool-compensation.adoc

@@ -247,7 +247,7 @@ A tool compensation is programmed using G43 H_n_, where _n_ is the index number
 It is intended that all entries in the tool table are positive.
 The value of H is checked, it must be a non-negative integer when read. The interpreter behaves as follows:
 
-1. If G43 H_n_ is programmed, a call to the function `USE_TOOL_LENGTH_OFFSET(`__length__`)` is made (where _length_ is the length difference, read from the tool table, of the indexed tool _n_),
+1. If G43 H__n__ is programmed, a call to the function `USE_TOOL_LENGTH_OFFSET(`__length__`)` is made (where _length_ is the length difference, read from the tool table, of the indexed tool _n_),
    tool_length_offset is repositioned in the machine settings model and the value of current_z in the model is adjusted.
    Note that _n_ does not have to be the same as the slot number of the tool currently in the spindle.
 

src/hal/components/plasmac.comp

@@ -65,8 +65,8 @@ pin in  float   gcode_scale = 1             "current G-code scale";
 pin in  float   height_override             "height override adjustment (volts)";
 pin in  float   height_per_volt             "torch height change per volt (machine units)";
 pin in  bit     homed                       "machine is homed";
-pin in  bit     ignore_arc_ok_0             "don't require arc ok for start or cutting";
-pin in  bit     ignore_arc_ok_1             "don't require arc ok for start or cutting";
+pin in  bit     ignore_arc_ok_0             "Do not require arc ok for start or cutting.";
+pin in  bit     ignore_arc_ok_1             "Do not require arc ok for start or cutting.";
 pin in  float   kerf_width                  "placeholder for better G-code portability between GUIs";
 pin in  bit     override_jog                "override jog inhibit";
 pin in  bit     offset_set_probe            "deploy probe for setting offsets";
@@ -78,7 +78,7 @@ pin in  s32     laser_y_offset              "alignment laser y axis offset (scal
 pin in  float   lowpass_frequency           "lowpass cutoff frequency for arc voltage output";
 pin in  bit     machine_is_on               "machine is on signal";
 pin in  s32     max_offset = 5              "maximum height offset";
-pin in  bit     mesh_arc_ok = FALSE         "don't require arc ok for mesh mode";
+pin in  bit     mesh_arc_ok = FALSE         "Do not require arc ok for mesh mode.";
 pin in  bit     mesh_enable                 "enable mesh cutting mode";
 pin in  s32     mode                        "operating mode";
 pin in  s32     motion_type                 "motion type, connect to motion.motion-type";
@@ -157,13 +157,13 @@ pin in  float   z_offset_current            "current z axis offset, connect to a
 pin in  float   zero_window = 0.1           "sets window that voltage fluctuations show as zero (-0.1 to 0.1 at default value)";
 // Pierce user control pins
 pin in  unsigned  pierce_type = 0           "allows motion to progress during pierce. 0=No movement, 1=Wiggle, 2=Ramp";
-pin in  float   pierce_motion_delay = 0     "delay starting motion during pierce delay period. This is a % of Pierce Delay. Only used when pierce-with-motion is True";
-pin in  float   cut_height_delay = 0        "at the end of transition to end-pierce-height how long to pause before transition to cut height";
-pin in  float   pierce_end_height = 0       "The height at end of piercing (in machine units). Can be different to Cut Height. Default 0 means not used. i.e. no change in height";
+pin in  float   pierce_motion_delay = 0     "delay starting motion during pierce delay period. This is a % of Pierce Delay. Only used when pierce-with-motion is True.";
+pin in  float   cut_height_delay = 0        "at the end of transition to end-pierce-height how long to pause before transition to cut height.";
+pin in  float   pierce_end_height = 0       "The height at end of piercing (in machine units). Can be different to Cut Height. Default 0 means not used. i.e. no change in height.";
 pin in  float   gouge_speed = 0             "Ramp starting speed for gouge. In machine units/min.";
-pin in  float   gouge_speed_distance = 0    "Distance gouge will run in machine units. Gouge plus creep distance should not be longer than any lead in";
+pin in  float   gouge_speed_distance = 0    "Distance gouge will run in machine units. Gouge plus creep distance should not be longer than any lead in.";
 pin in  float   creep_speed = 0             "Ramp creep or intermediate speed. Comes after gouge and is before cut speed. In machine units/min.";
-pin in  float   creep_speed_distance = 0    "Distance creep will run in machine units. Gouge plus creep distance should not be longer than any lead in";
+pin in  float   creep_speed_distance = 0    "Distance creep will run in machine units. Gouge plus creep distance should not be longer than any lead in.";
 
 /* OUTPUT PINS */
 pin out float   adaptive_feed               "for reverse-run, connect to motion.adaptive-feed";