docs: Docs comma culture (#4822)

Many non-English speaking countries use a comma as a decimal separator for printed numbers. This can create some confusion in documentation and config files when not surrounded by contextual clues like parenthesis.  Improve documentation by adding spaces to coordinates.

Signed-off-by: Paul McGowan <mental450@gmail.com>
This commit is contained in:
Paul McGowan 2022-01-09 21:13:53 -05:00 committed by GitHub
parent 4c8d24ae03
commit de366ee854
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
35 changed files with 201 additions and 201 deletions

View File

@ -51,7 +51,7 @@ probe_count: 5,3
- `probe_count: 5, 3`\ - `probe_count: 5, 3`\
_Default Value: 3, 3_\ _Default Value: 3, 3_\
The number of points to probe on each axis, specified as x,y integer The number of points to probe on each axis, specified as X, Y integer
values. In this example 5 points will be probed along the X axis, with values. In this example 5 points will be probed along the X axis, with
3 points along the Y axis, for a total of 15 probed points. Note that 3 points along the Y axis, for a total of 15 probed points. Note that
if you wanted a square grid, for example 3x3, this could be specified if you wanted a square grid, for example 3x3, this could be specified
@ -137,8 +137,8 @@ bicubic_tension: 0.2
_Default Value: 2, 2_\ _Default Value: 2, 2_\
The `mesh_pps` option is shorthand for Mesh Points Per Segment. This The `mesh_pps` option is shorthand for Mesh Points Per Segment. This
option specifies how many points to interpolate for each segment along option specifies how many points to interpolate for each segment along
the x and y axes. Consider a 'segment' to be the space between each the X and Y axes. Consider a 'segment' to be the space between each
probed point. Like `probe_count`, `mesh_pps` is specified as an x,y probed point. Like `probe_count`, `mesh_pps` is specified as an X, Y
integer pair, and also may be specified a single integer that is applied integer pair, and also may be specified a single integer that is applied
to both axes. In this example there are 4 segments along the X axis to both axes. In this example there are 4 segments along the X axis
and 2 segments along the Y axis. This evaluates to 8 interpolated and 2 segments along the Y axis. This evaluates to 8 interpolated

View File

@ -462,7 +462,7 @@ Only parameters specific to polar printers are described here - see
[common kinematic settings](#common-kinematic-settings) for available [common kinematic settings](#common-kinematic-settings) for available
parameters. parameters.
POLAR KINEMATICS ARE A WORK IN PROGRESS. Moves around the `0,0` POLAR KINEMATICS ARE A WORK IN PROGRESS. Moves around the 0, 0
position are known to not work properly. position are known to not work properly.
``` ```
@ -615,7 +615,7 @@ rotation_distance:
anchor_x: anchor_x:
anchor_y: anchor_y:
anchor_z: anchor_z:
# The x, y, and z position of the cable winch in cartesian space. # The X, Y, and Z position of the cable winch in cartesian space.
# These parameters must be provided. # These parameters must be provided.
``` ```
@ -826,24 +826,24 @@ Visual Examples:
# mesh_origin option. This parameter must be provided for round beds # mesh_origin option. This parameter must be provided for round beds
# and omitted for rectangular beds. # and omitted for rectangular beds.
#mesh_origin: #mesh_origin:
# Defines the center x,y coordinate of the mesh for round beds. This # Defines the center X, Y coordinate of the mesh for round beds. This
# coordinate is relative to the probe's location. It may be useful # coordinate is relative to the probe's location. It may be useful
# to adjust the mesh_origin in an effort to maximize the size of the # to adjust the mesh_origin in an effort to maximize the size of the
# mesh radius. Default is 0, 0. This parameter must be omitted for # mesh radius. Default is 0, 0. This parameter must be omitted for
# rectangular beds. # rectangular beds.
#mesh_min: #mesh_min:
# Defines the minimum x,y coordinate of the mesh for rectangular # Defines the minimum X, Y coordinate of the mesh for rectangular
# beds. This coordinate is relative to the probe's location. This # beds. This coordinate is relative to the probe's location. This
# will be the first point probed, nearest to the origin. This # will be the first point probed, nearest to the origin. This
# parameter must be provided for rectangular beds. # parameter must be provided for rectangular beds.
#mesh_max: #mesh_max:
# Defines the maximum x,y coordinate of the mesh for rectangular # Defines the maximum X, Y coordinate of the mesh for rectangular
# beds. Adheres to the same principle as mesh_min, however this will # beds. Adheres to the same principle as mesh_min, however this will
# be the furthest point probed from the bed's origin. This parameter # be the furthest point probed from the bed's origin. This parameter
# must be provided for rectangular beds. # must be provided for rectangular beds.
#probe_count: 3, 3 #probe_count: 3, 3
# For rectangular beds, this is a comma separate pair of integer # For rectangular beds, this is a comma separate pair of integer
# values (X,Y) defining the number of points to probe along each # values X, Y defining the number of points to probe along each
# axis. A single value is also valid, in which case that value will # axis. A single value is also valid, in which case that value will
# be applied to both axes. Default is 3, 3. # be applied to both axes. Default is 3, 3.
#round_probe_count: 5 #round_probe_count: 5
@ -872,7 +872,7 @@ Visual Examples:
# This is also the minimum length that a move can be split. Default # This is also the minimum length that a move can be split. Default
# is 5.0. # is 5.0.
#mesh_pps: 2, 2 #mesh_pps: 2, 2
# A comma separated pair of integers (X,Y) defining the number of # A comma separated pair of integers X, Y defining the number of
# points per segment to interpolate in the mesh along each axis. A # points per segment to interpolate in the mesh along each axis. A
# "segment" can be defined as the space between each probed point. # "segment" can be defined as the space between each probed point.
# The user may enter a single value which will be applied to both # The user may enter a single value which will be applied to both
@ -993,7 +993,7 @@ additional information.
``` ```
[screws_tilt_adjust] [screws_tilt_adjust]
#screw1: #screw1:
# The X,Y coordinate of the first bed leveling screw. This is a # The (X, Y) coordinate of the first bed leveling screw. This is a
# position to command the nozzle to that is directly above the bed # position to command the nozzle to that is directly above the bed
# screw (or as close as possible while still being above the bed). # screw (or as close as possible while still being above the bed).
# This is the base screw used in calculations. This parameter must # This is the base screw used in calculations. This parameter must
@ -1035,7 +1035,7 @@ extended [G-Code command](G-Codes.md#z-tilt) becomes available.
# A list of X, Y coordinates (one per line; subsequent lines # A list of X, Y coordinates (one per line; subsequent lines
# indented) describing the location of each bed "pivot point". The # indented) describing the location of each bed "pivot point". The
# "pivot point" is the point where the bed attaches to the given Z # "pivot point" is the point where the bed attaches to the given Z
# stepper. It is described using nozzle coordinates (the XY position # stepper. It is described using nozzle coordinates (the X, Y position
# of the nozzle if it could move directly above the point). The # of the nozzle if it could move directly above the point). The
# first entry corresponds to stepper_z, the second to stepper_z1, # first entry corresponds to stepper_z, the second to stepper_z1,
# the third to stepper_z2, etc. This parameter must be provided. # the third to stepper_z2, etc. This parameter must be provided.
@ -1082,7 +1082,7 @@ configuration:
|Z Z3| |Z Z3|
---------------- ----------------
``` ```
Where x is the (0,0) point on the bed Where x is the 0, 0 point on the bed
``` ```
[quad_gantry_level] [quad_gantry_level]
@ -1131,7 +1131,7 @@ the nature of skew correction these lengths are set via gcode. See
### [safe_z_home] ### [safe_z_home]
Safe Z homing. One may use this mechanism to home the Z axis at a Safe Z homing. One may use this mechanism to home the Z axis at a
specific XY coordinate. This is useful if the toolhead, for example specific X, Y coordinate. This is useful if the toolhead, for example
has to move to the center of the bed before Z can be homed. has to move to the center of the bed before Z can be homed.
``` ```
@ -1153,8 +1153,8 @@ home_xy_position:
# Speed (in mm/s) at which the Z axis is lifted prior to homing. The # Speed (in mm/s) at which the Z axis is lifted prior to homing. The
# default is 20mm/s. # default is 20mm/s.
#move_to_previous: False #move_to_previous: False
# When set to True, xy are reset to their previous positions after z # When set to True, the X and Y axes are reset to their previous
# homing. The default is False. # positions after Z axis homing. The default is False.
``` ```
### [homing_override] ### [homing_override]
@ -1490,10 +1490,10 @@ cs_pin:
# See the "common SPI settings" section for a description of the # See the "common SPI settings" section for a description of the
# above parameters. # above parameters.
#axes_map: x, y, z #axes_map: x, y, z
# The accelerometer axis for each of the printer's x, y, and z axes. # The accelerometer axis for each of the printer's X, Y, and Z axes.
# This may be useful if the accelerometer is mounted in an # This may be useful if the accelerometer is mounted in an
# orientation that does not match the printer orientation. For # orientation that does not match the printer orientation. For
# example, one could set this to "y,x,z" to swap the x and y axes. # example, one could set this to "y, x, z" to swap the X and Y axes.
# It is also possible to negate an axis if the accelerometer # It is also possible to negate an axis if the accelerometer
# direction is reversed (eg, "x, z, -y"). The default is "x, y, z". # direction is reversed (eg, "x, z, -y"). The default is "x, y, z".
#rate: 3200 #rate: 3200
@ -3891,7 +3891,7 @@ example.
``` ```
# The "replicape" config section adds "replicape:stepper_x_enable" # The "replicape" config section adds "replicape:stepper_x_enable"
# virtual stepper enable pins (for steppers x, y, z, e, and h) and # virtual stepper enable pins (for steppers X, Y, Z, E, and H) and
# "replicape:power_x" PWM output pins (for hotbed, e, h, fan0, fan1, # "replicape:power_x" PWM output pins (for hotbed, e, h, fan0, fan1,
# fan2, and fan3) that may then be used elsewhere in the config file. # fan2, and fan3) that may then be used elsewhere in the config file.
[replicape] [replicape]

View File

@ -445,7 +445,7 @@ The following commands are available when the
available while this tool is active. available while this tool is active.
- `BED_MESH_OUTPUT PGP=[<0:1>]`: This command outputs the current probed - `BED_MESH_OUTPUT PGP=[<0:1>]`: This command outputs the current probed
z values and current mesh values to the terminal. If PGP=1 is specified z values and current mesh values to the terminal. If PGP=1 is specified
the x,y coordinates generated by bed_mesh, along with their associated the X, Y coordinates generated by bed_mesh, along with their associated
indices, will be output to the terminal. indices, will be output to the terminal.
- `BED_MESH_MAP`: Like to BED_MESH_OUTPUT, this command prints the current - `BED_MESH_MAP`: Like to BED_MESH_OUTPUT, this command prints the current
state of the mesh to the terminal. Instead of printing the values in a state of the mesh to the terminal. Instead of printing the values in a

View File

@ -79,8 +79,8 @@ then one can start the tool by running:
BED_SCREWS_ADJUST BED_SCREWS_ADJUST
``` ```
This tool will move the printer's nozzle to each screw XY location and This tool will move the printer's nozzle to each screw XY location
then move the nozzle to a Z=0 height. At this point one can use the and then move the nozzle to a Z=0 height. At this point one can use the
"paper test" to adjust the bed screw directly under the nozzle. See "paper test" to adjust the bed screw directly under the nozzle. See
the information described in the information described in
["the paper test"](Bed_Level.md#the-paper-test), but adjust the bed ["the paper test"](Bed_Level.md#the-paper-test), but adjust the bed

View File

@ -1,6 +1,6 @@
# Probe calibration # Probe calibration
This document describes the method for calibrating the x, y, and z This document describes the method for calibrating the X, Y, and Z
offsets of an "automatic z probe" in Klipper. This is useful for users offsets of an "automatic z probe" in Klipper. This is useful for users
that have a `[probe]` or `[bltouch]` section in their config file. that have a `[probe]` or `[bltouch]` section in their config file.

View File

@ -36,7 +36,7 @@ Most drivers use 16 microsteps. If unsure, set `microsteps: 16` in the
config and use 16 in the formula above. config and use 16 in the formula above.
Almost all printers should have a whole number for `rotation_distance` Almost all printers should have a whole number for `rotation_distance`
on x, y, and z type axes. If the above formula results in a on X, Y, and Z type axes. If the above formula results in a
rotation_distance that is within .01 of a whole number then round the rotation_distance that is within .01 of a whole number then round the
final value to that whole_number. final value to that whole_number.