Skip to content

Commit 9c15afe

Browse files
authored
Use robot.forward() not robot.left() in examples
1 parent 9d7c689 commit 9c15afe

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

gpiozero/boards.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -758,12 +758,12 @@ class Robot(SourceMixin, CompositeDevice):
758758
backward pins of the left and right controllers respectively. For example,
759759
if the left motor's controller is connected to GPIOs 4 and 14, while the
760760
right motor's controller is connected to GPIOs 17 and 18 then the following
761-
example will turn the robot left::
761+
example will drive the robot forward::
762762
763763
from gpiozero import Robot
764764
765765
robot = Robot(left=(4, 14), right=(17, 18))
766-
robot.left()
766+
robot.forward()
767767
768768
:param tuple left:
769769
A tuple of two GPIO pins representing the forward and backward inputs
@@ -863,13 +863,13 @@ class RyanteckRobot(Robot):
863863
Extends :class:`Robot` for the `Ryanteck MCB`_ robot.
864864
865865
The Ryanteck MCB pins are fixed and therefore there's no need to specify
866-
them when constructing this class. The following example turns the robot
867-
left::
866+
them when constructing this class. The following example drives the robot
867+
forward::
868868
869869
from gpiozero import RyanteckRobot
870870
871871
robot = RyanteckRobot()
872-
robot.left()
872+
robot.forward()
873873
874874
.. _Ryanteck MCB: https://ryanteck.uk/add-ons/6-ryanteck-rpi-motor-controller-board-0635648607160.html
875875
"""
@@ -883,13 +883,13 @@ class CamJamKitRobot(Robot):
883883
Extends :class:`Robot` for the `CamJam #3 EduKit`_ robot controller.
884884
885885
The CamJam robot controller pins are fixed and therefore there's no need
886-
to specify them when constructing this class. The following example turns
887-
the robot left::
886+
to specify them when constructing this class. The following example drives
887+
the robot forward::
888888
889889
from gpiozero import CamJamKitRobot
890890
891891
robot = CamJamKitRobot()
892-
robot.left()
892+
robot.forward()
893893
894894
.. _CamJam #3 EduKit: http://camjam.me/?page_id=1035
895895
"""

0 commit comments

Comments
 (0)