aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Code_Overview.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2018-06-22 12:27:37 -0400
committerKevin O'Connor <kevin@koconnor.net>2018-06-22 14:09:01 -0400
commit0216201cb6b9b486a75e446ca1cb2bbd18f329d7 (patch)
treec13bf90fe6e6159b0e312e303c176138299c5c48 /docs/Code_Overview.md
parent20b404ecf5c55a67235b6556b21dcaef46c00200 (diff)
downloadkutter-0216201cb6b9b486a75e446ca1cb2bbd18f329d7.tar.gz
kutter-0216201cb6b9b486a75e446ca1cb2bbd18f329d7.tar.xz
kutter-0216201cb6b9b486a75e446ca1cb2bbd18f329d7.zip
delta: Rename get_position() to calc_position()
Calculating the cartesian position from the stepper positions can be complex and cpu intensive, so rename it to calc_position() to be more descriptive. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Code_Overview.md')
-rw-r--r--docs/Code_Overview.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/Code_Overview.md b/docs/Code_Overview.md
index c038f49d..1bb883f4 100644
--- a/docs/Code_Overview.md
+++ b/docs/Code_Overview.md
@@ -322,10 +322,10 @@ Useful steps:
4. Implement the `set_position()` method in the python code. This also
calculates the desired stepper positions given a cartesian
coordinate.
-5. Implement the `get_position()` method in the new kinematics
- class. This method is the inverse of set_position(). It does not
- need to be efficient as it is typically only called during homing
- and probing operations.
+5. Implement the `calc_position()` method in the new kinematics class.
+ This method is the inverse of set_position(). It does not need to
+ be efficient as it is typically only called during homing and
+ probing operations.
6. Implement the `move()` method. This method generally invokes the
iterative solver for each stepper.
7. Other methods. The `home()`, `check_move()`, and other methods