Skip to content

Commit 3c287af

Browse files
authored
Merge pull request #42 from sourcebots/api-docs-kier
API docs fixes
2 parents 98861bc + 1914add commit 3c287af

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/source/api/power-board.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ Power outputs
1313

1414
The six outputs of the power board are grouped together as ``power_board.outputs``.
1515

16-
The power boards six outputs can be turned on and off using the
16+
The power board's six outputs can be turned on and off using the
1717
``power_on`` and ``power_off`` functions of the group respectively.
1818

1919
.. Hint:: ``power_on`` is called when you setup your robot, so
20-
this doesnt need to be called manually. The ports will come on
20+
this doesn't need to be called manually. The ports will come on
2121
automatically as soon as your robot is ready, before the start button is
2222
pressed.
2323

@@ -42,7 +42,7 @@ An output is indexed using the appropriate ``PowerOutputPosition``.
4242
current_amps = r.power_board.outputs[PowerOutputPosition.H1].current
4343
4444
.. Warning:: The motor and servo boards are powered through these
45-
power outputs, whilst the power is off, you wont be able to control
45+
power outputs, whilst the power is off, you won't be able to control
4646
your motors or servos. They will register as a missing board and your code will
4747
break if you try and control them.
4848

@@ -66,7 +66,7 @@ The ``buzz`` function accepts multiple parameters, depending on what you
6666
want to play. The first argument is the duration of the beep, in
6767
seconds. The later arguments are either the note you want to play, or
6868
the frequency of the buzzer (in Hertz). You have to specify which of note
69-
or frequency youre passing using a keyword argument, your code will
69+
or frequency you're passing using a keyword argument, your code will
7070
fail otherwise.
7171

7272
Theoretically, the piezo buzzer will buzz at any provided frequency,
@@ -77,7 +77,7 @@ The ``Note`` enum provides notes in `scientific pitch notation
7777
<https://en.wikipedia.org/wiki/Scientific_pitch_notation>`__ between
7878
``C6`` and ``C8``. You can play other tones by providing a frequency.
7979

80-
.. Hint:: Calling ``buzz`` is non-blocking, which means it doesnt
80+
.. Hint:: Calling ``buzz`` is non-blocking, which means it doesn't
8181
actually wait for the piezo to stop buzzing before continuing with your
8282
code. If you want to wait for the buzzing to stop, add a
8383
``sleep`` afterwards! If you send more than 32 beeps to the robot too

docs/source/api/servo-board.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,5 +58,5 @@ will turn to for a given pulse width. To be able to handle the widest
5858
range of all servos our hardware outputs a very wide range of pulse
5959
widths which in some cases will force the servo to try and turn past its
6060
internal end-stops. You should experiment and find what the actual limit
61-
of your servos are (it almost certainly wont be -1 and 1) and not
61+
of your servos are (it almost certainly won't be -1 and 1) and not
6262
drive them past that.

0 commit comments

Comments
 (0)