3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Use "look-ahead" instead of "lookahead" in Code Overview 

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2017-04-27 12:02:15 -04:00
parent 4f7237de44
commit d73340474b
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Code_Overview.md
View File

@ -124,13 +124,13 @@ provides further information on the mechanics of moves.
cmd_G1()`. Ultimately the ToolHead class is invoked to execute the cmd_G1()`. Ultimately the ToolHead class is invoked to execute the
actual request: `cmd_G1() -> ToolHead.move()` actual request: `cmd_G1() -> ToolHead.move()`
* The ToolHead class (in toolhead.py) handles "lookahead" and tracks * The ToolHead class (in toolhead.py) handles "look-ahead" and tracks
the timing of printing actions. The codepath for a move is: the timing of printing actions. The codepath for a move is:
`ToolHead.move() -> MoveQueue.add_move() -> MoveQueue.flush() -> `ToolHead.move() -> MoveQueue.add_move() -> MoveQueue.flush() ->
Move.set_junction() -> Move.move()`. Move.set_junction() -> Move.move()`.
* ToolHead.move() creates a Move() object with the parameters of the * ToolHead.move() creates a Move() object with the parameters of the
move (in cartesian space and in units of seconds and millimeters). move (in cartesian space and in units of seconds and millimeters).
* MoveQueue.add_move() places the move object on the "lookahead" * MoveQueue.add_move() places the move object on the "look-ahead"
queue. queue.
* MoveQueue.flush() determines the start and end velocities of each * MoveQueue.flush() determines the start and end velocities of each
move. move.
@ -155,7 +155,7 @@ provides further information on the mechanics of moves.
are in cartesian.py, corexy.py, delta.py, and extruder.py. The are in cartesian.py, corexy.py, delta.py, and extruder.py. The
kinematic class is given a chance to audit the move kinematic class is given a chance to audit the move
(`ToolHead.move() -> kin.check_move()`) before it goes on the (`ToolHead.move() -> kin.check_move()`) before it goes on the
lookahead queue, but once the move arrives in *kin*.move() the look-ahead queue, but once the move arrives in *kin*.move() the
kinematic class is required to handle the move as specified. The kinematic class is required to handle the move as specified. The
kinematic classes translate the three parts of each move kinematic classes translate the three parts of each move
(acceleration, constant "cruising" velocity, and deceleration) to (acceleration, constant "cruising" velocity, and deceleration) to