From 10bceb970eeaff6ec671f2f47943bd379a31fb12 Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Tue, 19 May 2020 11:27:50 +0200 Subject: [PATCH] doc/ev3: doc8 for inc files --- doc/api/hubs_ev3brick.inc | 47 +++++++++++++++++++++++---------------- doc/api/iodevices_ev3.inc | 8 ++++--- 2 files changed, 33 insertions(+), 22 deletions(-) diff --git a/doc/api/hubs_ev3brick.inc b/doc/api/hubs_ev3brick.inc index 5c4f8ba..94c943c 100644 --- a/doc/api/hubs_ev3brick.inc +++ b/doc/api/hubs_ev3brick.inc @@ -14,7 +14,8 @@ **Example: Turn the light on and change the color.** - .. literalinclude:: ../../pybricks-projects/snippets/ev3/light_color/main.py + .. literalinclude:: + ../../pybricks-projects/snippets/ev3/light_color/main.py .. automethod:: pybricks.hubs::EV3Brick.light.off @@ -29,20 +30,24 @@ Each note is a string with the following format: - - The first character is the name of the note, ``A`` to ``G`` or ``R`` - for a rest. - - Note names can also include an accidental ``#`` (sharp) or ``b`` - (flat). ``B#``/``Cb`` and ``E#``/``Fb`` are not allowed. - - The note name is followed by the octave number ``2`` to ``8``. For - example ``C4`` is middle C. The octave changes to the next number at - the note C, for example, ``B3`` is the note below middle C (``C4``). - - The octave is followed by ``/`` and a number that indicates the size - of the note. For example ``/4`` is a quarter note, ``/8`` is an - eight note and so on. - - This can optionally followed by a ``.`` to make a dotted note. - Dotted notes are 1-1/2 times as long as notes without a dot. - - The note can optionally end with a ``_`` which is a tie or a slur. - This causes there to be no pause between this note and the next note. + - The first character is the name of the note, ``A`` to ``G`` + or ``R`` for a rest. + - Note names can also include an accidental ``#`` (sharp) or + ``b`` (flat). ``B#``/``Cb`` and ``E#``/``Fb`` are not + allowed. + - The note name is followed by the octave number ``2`` + to ``8``. For example ``C4`` is middle C. The octave changes + to the next number at the note C, for example, ``B3`` is the + note below middle C (``C4``). + - The octave is followed by ``/`` and a number that indicates + the size of the note. For example ``/4`` is a quarter note, + ``/8`` is an eight note and so on. + - This can optionally followed by a ``.`` to make a dotted + note. Dotted notes are 1-1/2 times as long as notes without a + dot. + - The note can optionally end with a ``_`` which is a tie or a + slur. This causes there to be no pause between this note and + the next note. .. automethod:: pybricks.hubs::EV3Brick.speaker.play_file @@ -70,7 +75,8 @@ - ``'en-gb'``: English (United Kingdom) - ``'en-sc'``: English (Scotland) - ``'en-uk-north'``: English (United Kingdom, Northern) - - ``'en-uk-rp'``: English (United Kingdom, Received Pronunciation) + - ``'en-uk-rp'``: + English (United Kingdom, Received Pronunciation) - ``'en-uk-wmids'``: English (United Kingdom, West Midlands) - ``'en-us'``: English (United States) - ``'en-wi'``: English (West Indies) @@ -167,7 +173,8 @@ \begin{CJK}{UTF8}{gbsn} - .. literalinclude:: ../../pybricks-projects/snippets/ev3/screen_print/main.py + .. literalinclude:: + ../../pybricks-projects/snippets/ev3/screen_print/main.py .. raw:: latex @@ -184,7 +191,8 @@ **Example: Show an image on the screen.** - .. literalinclude:: ../../pybricks-projects/snippets/ev3/screen_image/main.py + .. literalinclude:: + ../../pybricks-projects/snippets/ev3/screen_image/main.py .. automethod:: pybricks.hubs::EV3Brick.screen.draw_image @@ -197,7 +205,8 @@ **Example: Draw some shapes on the screen.** - .. literalinclude:: ../../pybricks-projects/snippets/ev3/screen_draw/main.py + .. literalinclude:: + ../../pybricks-projects/snippets/ev3/screen_draw/main.py .. automethod:: pybricks.hubs::EV3Brick.screen.draw_box diff --git a/doc/api/iodevices_ev3.inc b/doc/api/iodevices_ev3.inc index bb77260..29756dd 100644 --- a/doc/api/iodevices_ev3.inc +++ b/doc/api/iodevices_ev3.inc @@ -130,8 +130,9 @@ visit the `ev3dev sensors`_ page. In this example we use the LEGO MINDSTORMS EV3 Color Sensor with the raw RGB mode. This gives uncalibrated red, green, and blue reflection values. - - .. literalinclude:: ../../pybricks-projects/snippets/ev3/ev3devsensor/main.py + + .. literalinclude:: + ../../pybricks-projects/snippets/ev3/ev3devsensor/main.py .. toggle-header:: :header: **Show/hide example: Extending the Ev3devSensor class** @@ -141,7 +142,8 @@ visit the `ev3dev sensors`_ page. This example shows how to extend the ``Ev3devSensor`` class by accessing additional features found in the Linux system folder for this device. - .. literalinclude:: ../../pybricks-projects/snippets/ev3/ev3devsensor/class_example.py + .. literalinclude:: + ../../pybricks-projects/snippets/ev3/ev3devsensor/class_example.py .. _ev3dev sensors: http://docs.ev3dev.org/projects/lego-linux-drivers/en/ev3dev-stretch/sensors.html .. _Mode name: http://docs.ev3dev.org/projects/lego-linux-drivers/en/ev3dev-stretch/sensor_data.html