Skip to content

Commit 848a78d

Browse files
docs: Fix typos (Klipper3d#6032)
Signed-off-by: Thijs Triemstra <info@collab.nl>
1 parent aca0c71 commit 848a78d

10 files changed

+37
-37
lines changed

docs/Bed_Mesh.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Bed Mesh
22

3-
The Bed Mesh module may be used to compensate for bed surface irregularties to
4-
achieve a better first layer across the entire bed. It should be noted that
5-
software based correction will not achieve perfect results, it can only
3+
The Bed Mesh module may be used to compensate for bed surface irregularities
4+
to achieve a better first layer across the entire bed. It should be noted
5+
that software based correction will not achieve perfect results, it can only
66
approximate the shape of the bed. Bed Mesh also cannot compensate for
77
mechanical and electrical issues. If an axis is skewed or a probe is not
88
accurate then the bed_mesh module will not receive accurate results from
@@ -46,7 +46,7 @@ probe_count: 5, 3
4646
_Required_\
4747
The probed coordinate farthest farthest from the origin. This is not
4848
necessarily the last point probed, as the probing process occurs in a
49-
zig-zag fashion. As with `mesh_min`, this coordiante is relative to
49+
zig-zag fashion. As with `mesh_min`, this coordinate is relative to
5050
the probe's location.
5151

5252
- `probe_count: 5, 3`\
@@ -101,7 +101,7 @@ round_probe_count: 5
101101
that the center of the mesh is probed.
102102

103103
The illustration below shows how the probed points are generated. As you can see,
104-
setting the `mesh_origin` to (-10, 0) allows us to specifiy a larger mesh radius
104+
setting the `mesh_origin` to (-10, 0) allows us to specify a larger mesh radius
105105
of 85.
106106

107107
![bedmesh_round_basic](img/bedmesh_round_basic.svg)
@@ -114,7 +114,7 @@ Each of the advanced options apply to round beds in the same manner.
114114

115115
### Mesh Interpolation
116116

117-
While its possible to sample the probed matrix directly using simple bilinear
117+
While its possible to sample the probed matrix directly using simple bi-linear
118118
interpolation to determine the Z-Values between probed points, it is often
119119
useful to interpolate extra points using more advanced interpolation algorithms
120120
to increase mesh density. These algorithms add curvature to the mesh,
@@ -207,7 +207,7 @@ split_delta_z: .025
207207
Generally the default values for these options are sufficient, in fact the
208208
default value of 5mm for the `move_check_distance` may be overkill. However an
209209
advanced user may wish to experiment with these options in an effort to squeeze
210-
out the optimial first layer.
210+
out the optimal first layer.
211211

212212
### Mesh Fade
213213

@@ -263,9 +263,9 @@ fade_target: 0
263263

264264
### The Relative Reference Index
265265

266-
Most probes are suceptible to drift, ie: inaccuracies in probing introduced by
266+
Most probes are susceptible to drift, ie: inaccuracies in probing introduced by
267267
heat or interference. This can make calculating the probe's z-offset
268-
challenging, particuarly at different bed temperatures. As such, some printers
268+
challenging, particularly at different bed temperatures. As such, some printers
269269
use an endstop for homing the Z axis, and a probe for calibrating the mesh.
270270
These printers can benefit from configuring the relative reference index.
271271

docs/Bootloaders.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ is a [fork with builds specific to the SKR Mini E3 1.2](
305305
https://github.com/Arksine/STM32_HID_Bootloader/releases/latest).
306306

307307
For generic STM32F103 boards such as the blue pill it is possible to flash
308-
the bootloader via 3.3v serial using stm32flash as noted in the stm32duino
308+
the bootloader via 3.3V serial using stm32flash as noted in the stm32duino
309309
section above, substituting the file name for the desired hid bootloader binary
310310
(ie: hid_generic_pc13.bin for the blue pill).
311311

@@ -382,15 +382,15 @@ make flash FLASH_DEVICE=/dev/ttyACM0
382382
It may be necessary to manually enter the bootloader, this can be done by
383383
setting "boot 0" low and "boot 1" high. On the SKR Mini E3 "Boot 1" is
384384
not available, so it may be done by setting pin PA2 low if you flashed
385-
"hid_btt_skr_mini_e3.bin". This pin is labeld "TX0" on the TFT header in
385+
"hid_btt_skr_mini_e3.bin". This pin is labeled "TX0" on the TFT header in
386386
the SKR Mini E3's "PIN" document. There is a ground pin next to PA2
387387
which you can use to pull PA2 low.
388388

389389
### STM32F103/STM32F072 with MSC bootloader
390390

391391
The [MSC bootloader](https://github.com/Telekatz/MSC-stm32f103-bootloader) is a driverless bootloader capable of flashing over USB.
392392

393-
It is possible to flash the bootloader via 3.3v serial using stm32flash as noted
393+
It is possible to flash the bootloader via 3.3V serial using stm32flash as noted
394394
in the stm32duino section above, substituting the file name for the desired
395395
MSC bootloader binary (ie: MSCboot-Bluepill.bin for the blue pill).
396396

@@ -419,7 +419,7 @@ It is recommended to use a ST-Link Programmer to flash CanBoot, however it
419419
should be possible to flash using `stm32flash` on STM32F103 devices, and
420420
`dfu-util` on STM32F042/STM32F072 devices. See the previous sections in this
421421
document for instructions on these flashing methods, substituting `canboot.bin`
422-
for the file name where appropriate. The CanBoot repo linked above provides
422+
for the file name where appropriate. The CanBoot repository linked above provides
423423
instructions for building the bootloader.
424424

425425
The first time CanBoot has been flashed it should detect that no application
@@ -448,8 +448,8 @@ When building Klipper for use with CanBoot, select the 8 KiB Bootloader option.
448448

449449
## STM32F4 micro-controllers (SKR Pro 1.1)
450450

451-
STM32F4 microcontrollers come equipped with a built-in system bootloader
452-
capable of flashing over USB (via DFU), 3.3v Serial, and various other
451+
STM32F4 micro-controllers come equipped with a built-in system bootloader
452+
capable of flashing over USB (via DFU), 3.3V Serial, and various other
453453
methods (see STM Document AN2606 for more information). Some
454454
STM32F4 boards, such as the SKR Pro 1.1, are not able to enter the DFU
455455
bootloader. The HID bootloader is available for STM32F405/407
@@ -458,8 +458,8 @@ Note that you may need to configure and build a version specific to your
458458
board, a [build for the SKR Pro 1.1 is available here](
459459
https://github.com/Arksine/STM32_HID_Bootloader/releases/latest).
460460

461-
Unless your board is DFU capable the most accessable flashing method
462-
is likely via 3.3v serial, which follows the same procedure as
461+
Unless your board is DFU capable the most accessible flashing method
462+
is likely via 3.3V serial, which follows the same procedure as
463463
[flashing the STM32F103 using stm32flash](#stm32f103-micro-controllers-blue-pill-devices).
464464
For example:
465465
```

docs/Config_Reference.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ max_z_velocity:
346346
#min_angle: 5
347347
# This represents the minimum angle (in degrees) relative to horizontal
348348
# that the deltesian arms are allowed to achieve. This parameter is
349-
# intended to restrict the arms from becomming completely horizontal,
349+
# intended to restrict the arms from becoming completely horizontal,
350350
# which would risk accidental inversion of the XZ axis. The default is 5.
351351
#print_width:
352352
# The distance (in mm) of valid toolhead X coordinates. One may use
@@ -383,7 +383,7 @@ arm_x_length:
383383
# for stepper_right, this parameter defaults to the value specified for
384384
# stepper_left.
385385
386-
# The stepper_right section is used to desribe the stepper controlling the
386+
# The stepper_right section is used to describe the stepper controlling the
387387
# right tower.
388388
[stepper_right]
389389
@@ -4323,7 +4323,7 @@ serial:
43234323
#auto_load_speed: 2
43244324
# Extrude feedrate when autoloading, default is 2 (mm/s)
43254325
#auto_cancel_variation: 0.1
4326-
# Auto cancel print when ping varation is above this threshold
4326+
# Auto cancel print when ping variation is above this threshold
43274327
```
43284328

43294329
### [angle]

docs/Debugging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ after the above compilation:
216216
```
217217
ls ./build/pysimulavr/_pysimulavr.*.so
218218
```
219-
This commmand should report a specific file (e.g.
219+
This command should report a specific file (e.g.
220220
**./build/pysimulavr/_pysimulavr.cpython-39-x86_64-linux-gnu.so**) and
221221
not an error.
222222

docs/Features.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Klipper has several compelling features:
1515
movement provides quieter and more stable printer operation.
1616

1717
* Best in class performance. Klipper is able to achieve high stepping
18-
rates on both new and old micro-controllers. Even old 8bit
18+
rates on both new and old micro-controllers. Even old 8-bit
1919
micro-controllers can obtain rates over 175K steps per second. On
2020
more recent micro-controllers, several million steps per second are
2121
possible. Higher stepper rates enable higher print velocities. The

docs/Hall_Filament_Width_Sensor.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document describes Filament Width Sensor host module. Hardware used for
44
developing this host module is based on two Hall linear sensors (ss49e for
5-
example). Sensors in the body are located opposite sides. Principle of operation:
5+
example). Sensors in the body are located on opposite sides. Principle of operation:
66
two hall sensors work in differential mode, temperature drift same for sensor.
77
Special temperature compensation not needed.
88

@@ -18,9 +18,9 @@ To use Hall filament width sensor, read
1818

1919
Sensor generates two analog output based on calculated filament width. Sum of
2020
output voltage always equals to detected filament width. Host module monitors
21-
voltage changes and adjusts extrusion multiplier. I use aux2 connector on
22-
ramps-like board analog11 and analog12 pins. You can use different pins and
23-
differenr boards.
21+
voltage changes and adjusts extrusion multiplier. I use the aux2 connector on
22+
a ramps-like board with the analog11 and analog12 pins. You can use different pins
23+
and different boards.
2424

2525
## Template for menu variables
2626

docs/Measuring_Resonances.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ that it has a voltage regulator and a level shifter.
1919
### Wiring
2020

2121
An ethernet cable with shielded twisted pairs (cat5e or better) is recommended
22-
for signal integrety over a long distance. If you still experience signal integrity
22+
for signal integrity over a long distance. If you still experience signal integrity
2323
issues (SPI/I2C errors), shorten the cable.
2424

2525
Connect ethernet cable shielding to the controller board/RPI ground.
@@ -41,15 +41,15 @@ SCLK+CS
4141

4242

4343
**Note: Many MCUs will work with an ADXL345 in SPI mode(eg Pi Pico), wiring and
44-
configuration will vary according to your specific board and avaliable pins.**
44+
configuration will vary according to your specific board and available pins.**
4545

4646
You need to connect ADXL345 to your Raspberry Pi via SPI. Note that the I2C
4747
connection, which is suggested by ADXL345 documentation, has too low throughput
4848
and **will not work**. The recommended connection scheme:
4949

5050
| ADXL345 pin | RPi pin | RPi pin name |
5151
|:--:|:--:|:--:|
52-
| 3V3 (or VCC) | 01 | 3.3v DC power |
52+
| 3V3 (or VCC) | 01 | 3.3V DC power |
5353
| GND | 06 | Ground |
5454
| CS | 24 | GPIO08 (SPI0_CE0_N) |
5555
| SDO | 21 | GPIO09 (SPI0_MISO) |
@@ -310,7 +310,7 @@ or you can choose some other configuration yourself based on the generated
310310
charts: peaks in the power spectral density on the charts correspond to
311311
the resonance frequencies of the printer.
312312

313-
Note that alternatively you can run the input shaper autocalibration
313+
Note that alternatively you can run the input shaper auto-calibration
314314
from Klipper [directly](#input-shaper-auto-calibration), which can be
315315
convenient, for example, for the input shaper
316316
[re-calibration](#input-shaper-re-calibration).
@@ -550,9 +550,9 @@ supplying `AXIS=` parameter, like
550550
SHAPER_CALIBRATE AXIS=X
551551
```
552552

553-
**Warning!** It is not advisable to run the shaper autocalibration very
553+
**Warning!** It is not advisable to run the shaper auto-calibration very
554554
frequently (e.g. before every print, or every day). In order to determine
555-
resonance frequencies, autocalibration creates intensive vibrations on each of
555+
resonance frequencies, auto-calibration creates intensive vibrations on each of
556556
the axes. Generally, 3D printers are not designed to withstand a prolonged
557557
exposure to vibrations near the resonance frequencies. Doing so may increase
558558
wear of the printer components and reduce their lifespan. There is also an

docs/Overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ communication with the Klipper developers.
5454
perfectly square.
5555
- [PWM tools](Using_PWM_Tools.md): Guide on how to use PWM controlled
5656
tools such as lasers or spindles.
57-
- [Exclude Object](Exclude_Object.md): The guide to the Exclude Objecs
57+
- [Exclude Object](Exclude_Object.md): The guide to the Exclude Objects
5858
implementation.
5959

6060
## Developer Documentation

docs/Packaging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ follows: `python2 scripts/make_version.py YOURDISTRONAME > klippy/.version`.
2727
## Sample packaging script
2828

2929
klipper-git is packaged for Arch Linux, and has a PKGBUILD (package build
30-
script) available at [Arch User Repositiory](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=klipper-git).
30+
script) available at [Arch User Repository](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=klipper-git).

docs/SDCard_Updates.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -127,13 +127,13 @@ BOARD_DEFS = {
127127
```
128128

129129
The following fields may be specified:
130-
- `mcu`: The mcu type. This can be retrevied after configuring the build
130+
- `mcu`: The mcu type. This can be retrieved after configuring the build
131131
via `make menuconfig` by running `cat .config | grep CONFIG_MCU`. This
132132
field is required.
133-
- `spi_bus`: The SPI bus connected to the SD Card. This should be retreived
133+
- `spi_bus`: The SPI bus connected to the SD Card. This should be retrieved
134134
from the board's schematic. This field is required.
135135
- `cs_pin`: The Chip Select Pin connected to the SD Card. This should be
136-
retreived from the board schematic. This field is required.
136+
retrieved from the board schematic. This field is required.
137137
- `firmware_path`: The path on the SD Card where firmware should be
138138
transferred. The default is `firmware.bin`.
139139
- `current_firmware_path`: The path on the SD Card where the renamed firmware

0 commit comments

Comments
 (0)