Skip to content

Commit 98f6101

Browse files
authored
Merge pull request #501 from KurtJacobson/py_interface_docs
docs: fix formatting of spindle dict section heading
2 parents d42d9b0 + 359bb80 commit 98f6101

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

docs/src/config/python-interface.txt

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,8 @@ by the configuration parameter [JOINT_n]UNITS)
492492
*velocity*:: '(returns float)' -
493493
current velocity.
494494

495-
== The 'spindle' dictionary [[sec:the-spindle-dictionary] ==
495+
== The `spindle` dictionary [[sec:the-spindle-dictionary]
496+
496497
*brake*:: '(returns integer)' -
497498
value of the spindle brake flag.
498499

@@ -583,7 +584,7 @@ c.flood(linuxcnc.FLOOD_OFF)
583584

584585
c.home(2)
585586

586-
c.jog(linuxcnc.JOG_STOP, jogmode, axis)
587+
c.jog(linuxcnc.JOG_STOP, jogmode, axis)
587588
c.jog(linuxcnc.JOG_CONTINUOUS, jogmode, axis, velocity)
588589
c.jog(linuxcnc.JOG_INCREMENT, jogmode, axis, velocity, increment)
589590

@@ -717,8 +718,8 @@ c.tool_offset(toolno, z_offset, x_offset, diameter, frontangle, backangle, orie
717718
`set_optional_stop(int)`::
718719
set optional stop on/off
719720

720-
`set_spindle_override(int)`::
721-
set spindle override flag
721+
`set_spindle_override(int [, int])`::
722+
set spindle override enabled. Defaults to spindle 0.
722723

723724
`spindle(int [[float] [int] [float,int]])`::
724725
set spindle direction. Argument one of SPINDLE_FORWARD,
@@ -731,7 +732,7 @@ import linuxcnc
731732
c = linuxcnc.command()
732733

733734
#Increase speed of spindle 0 by 100rpm. Spindle must be on first
734-
c.spindle(linuxcnc.INCREASE)
735+
c.spindle(linuxcnc.INCREASE)
735736

736737
#Increase speed of spindle 2 by 100rpm. Spindle must be on first
737738
c.spindle(linuxcnc.SPINDLE_INCREASE, 2)
@@ -740,7 +741,7 @@ c.spindle(linuxcnc.SPINDLE_INCREASE, 2)
740741
c.spindle.(linuxcnc.SPINDLE_FORWARD, 1024)
741742

742743
#Set speed of spindle 1 to -666 rpm
743-
c.spindle.(linuxcnc.SPINDLE_REVERSE, 666,1)
744+
c.spindle.(linuxcnc.SPINDLE_REVERSE, 666, 1)
744745

745746
#Stop spindle 0
746747
c.spindle.(linuxcnc.SPINDLE_OFF)
@@ -751,7 +752,7 @@ c.spindle.(linuxcnc.SPINDLE_OFF, 0)
751752

752753

753754
`spindleoverride(float [, int])`::
754-
set spindle override factor. Defaults to spindle 0.
755+
set spindle override factor. Defaults to spindle 0.
755756

756757
`state(int)`::
757758
set the machine state. Machine state should be STATE_ESTOP, STATE_ESTOP_RESET, STATE_ON, or STATE_OFF

0 commit comments

Comments
 (0)