Skip to content

Commit dcadfa1

Browse files
committed
docs: lead with the deprecation notice for the switchkins pin
The paragraph read as though the pin were an equal alternative that happened to carry a caveat. State the deprecation first, as a warning.
1 parent f9efeb3 commit dcadfa1

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

‎docs/src/gcode/g-code.adoc‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -947,11 +947,13 @@ G13.1
947947
module, and 'G13.1' cancels back to kinematics 0. The 'P' word is the
948948
kinematics number, so 'G13.1' and `G12.1 P0` do the same thing.
949949

950-
These are the way to select a kinematics. The `motion.switchkins-type`
951-
HAL pin does the same thing and takes the same numbering, but it is
952-
deprecated: the interpreter never sees it, so a program is read, its
953-
limits checked and its path looked ahead in whatever kinematics the
954-
interpreter last knew about, which need not be the one that runs it.
950+
[WARNING]
951+
Deprecation notice: selecting the kinematics by writing the
952+
`motion.switchkins-type` HAL pin is deprecated. It takes the same
953+
numbering and still works, but it does not tell the interpreter that
954+
anything changed, so a program is read, its limits checked and its path
955+
looked ahead in whatever kinematics the interpreter last knew about,
956+
which need not be the one that runs it. Use 'G12.1' and 'G13.1'.
955957

956958
Both codes are queue synchronisation points. The interpreter waits for
957959
queued motion to finish before the kinematics changes, so no move is ever

0 commit comments

Comments
 (0)