summaryrefslogtreecommitdiff
path: root/docs/library
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2019-12-04 15:02:54 +1100
committerDamien George <damien.p.george@gmail.com>2019-12-04 15:02:54 +1100
commit90c524c1141ed9ad8fa882dba6f36199a7768e32 (patch)
tree0ee0799df23cb231c47de6f0b885d6f124e448c6 /docs/library
parent40cc7ec677e962c47db567479e42c27ed8911ff6 (diff)
docs: Remove spaces on lines that are empty.
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/lcd160cr.rst2
-rw-r--r--docs/library/machine.RTC.rst2
-rw-r--r--docs/library/machine.TimerWiPy.rst6
-rw-r--r--docs/library/pyb.ADC.rst2
-rw-r--r--docs/library/pyb.Accel.rst2
-rw-r--r--docs/library/pyb.CAN.rst2
-rw-r--r--docs/library/pyb.ExtInt.rst2
-rw-r--r--docs/library/pyb.LCD.rst8
-rw-r--r--docs/library/pyb.LED.rst2
-rw-r--r--docs/library/pyb.RTC.rst6
-rw-r--r--docs/library/pyb.Timer.rst4
-rw-r--r--docs/library/pyb.USB_HID.rst4
-rw-r--r--docs/library/pyb.USB_VCP.rst8
-rw-r--r--docs/library/pyb.rst12
14 files changed, 31 insertions, 31 deletions
diff --git a/docs/library/lcd160cr.rst b/docs/library/lcd160cr.rst
index bb8e6da22..e31ed9465 100644
--- a/docs/library/lcd160cr.rst
+++ b/docs/library/lcd160cr.rst
@@ -340,7 +340,7 @@ Advanced commands
.. method:: LCD160CR.set_scroll_win_param(win, param, value)
Set a single parameter of a scrolling window region:
-
+
- *win* is the window id, 0..8.
- *param* is the parameter number to configure, 0..7, and corresponds
to the parameters in the `set_scroll_win` method.
diff --git a/docs/library/machine.RTC.rst b/docs/library/machine.RTC.rst
index 95fa2b4ce..548ad007e 100644
--- a/docs/library/machine.RTC.rst
+++ b/docs/library/machine.RTC.rst
@@ -27,7 +27,7 @@ Methods
.. method:: RTC.init(datetime)
Initialise the RTC. Datetime is a tuple of the form:
-
+
``(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])``
.. method:: RTC.now()
diff --git a/docs/library/machine.TimerWiPy.rst b/docs/library/machine.TimerWiPy.rst
index abbcc28ff..904a958c6 100644
--- a/docs/library/machine.TimerWiPy.rst
+++ b/docs/library/machine.TimerWiPy.rst
@@ -47,9 +47,9 @@ Methods
tim.init(Timer.ONE_SHOT, width=32) # one shot 32-bit timer
Keyword arguments:
-
+
- ``mode`` can be one of:
-
+
- ``TimerWiPy.ONE_SHOT`` - The timer runs once until the configured
period of the channel expires.
- ``TimerWiPy.PERIODIC`` - The timer runs periodically at the configured
@@ -70,7 +70,7 @@ Methods
object is returned (or ``None`` if there is no previous channel).
Otherwise, a TimerChannel object is initialized and returned.
-
+
The operating mode is is the one configured to the Timer object that was used to
create the channel.
diff --git a/docs/library/pyb.ADC.rst b/docs/library/pyb.ADC.rst
index a95f2d537..1b16e0c2f 100644
--- a/docs/library/pyb.ADC.rst
+++ b/docs/library/pyb.ADC.rst
@@ -19,7 +19,7 @@ Usage::
val = adc.read_core_vref() # read MCU VREF
val = adc.read_vref() # read MCU supply voltage
-
+
Constructors
------------
diff --git a/docs/library/pyb.Accel.rst b/docs/library/pyb.Accel.rst
index 9ade5c5c8..d5c0ca863 100644
--- a/docs/library/pyb.Accel.rst
+++ b/docs/library/pyb.Accel.rst
@@ -19,7 +19,7 @@ Constructors
.. class:: pyb.Accel()
Create and return an accelerometer object.
-
+
Methods
-------
diff --git a/docs/library/pyb.CAN.rst b/docs/library/pyb.CAN.rst
index 09b97a187..ba935abfd 100644
--- a/docs/library/pyb.CAN.rst
+++ b/docs/library/pyb.CAN.rst
@@ -92,7 +92,7 @@ Methods
Force a software restart of the CAN controller without resetting its
configuration.
-
+
If the controller enters the bus-off state then it will no longer participate
in bus activity. If the controller is not configured to automatically restart
(see :meth:`~CAN.init()`) then this method can be used to trigger a restart,
diff --git a/docs/library/pyb.ExtInt.rst b/docs/library/pyb.ExtInt.rst
index 814217cef..7741cc51e 100644
--- a/docs/library/pyb.ExtInt.rst
+++ b/docs/library/pyb.ExtInt.rst
@@ -54,7 +54,7 @@ Constructors
.. class:: pyb.ExtInt(pin, mode, pull, callback)
Create an ExtInt object:
-
+
- ``pin`` is the pin on which to enable the interrupt (can be a pin object or any valid pin name).
- ``mode`` can be one of:
- ``ExtInt.IRQ_RISING`` - trigger on a rising edge;
diff --git a/docs/library/pyb.LCD.rst b/docs/library/pyb.LCD.rst
index 5ab127edc..018902ca6 100644
--- a/docs/library/pyb.LCD.rst
+++ b/docs/library/pyb.LCD.rst
@@ -63,13 +63,13 @@ Methods
.. method:: LCD.fill(colour)
Fill the screen with the given colour (0 or 1 for white or black).
-
+
This method writes to the hidden buffer. Use ``show()`` to show the buffer.
.. method:: LCD.get(x, y)
Get the pixel at the position ``(x, y)``. Returns 0 or 1.
-
+
This method reads from the visible buffer.
.. method:: LCD.light(value)
@@ -79,7 +79,7 @@ Methods
.. method:: LCD.pixel(x, y, colour)
Set the pixel at ``(x, y)`` to the given colour (0 or 1).
-
+
This method writes to the hidden buffer. Use ``show()`` to show the buffer.
.. method:: LCD.show()
@@ -89,7 +89,7 @@ Methods
.. method:: LCD.text(str, x, y, colour)
Draw the given text to the position ``(x, y)`` using the given colour (0 or 1).
-
+
This method writes to the hidden buffer. Use ``show()`` to show the buffer.
.. method:: LCD.write(str)
diff --git a/docs/library/pyb.LED.rst b/docs/library/pyb.LED.rst
index 1ab73a69c..d3ab965e7 100644
--- a/docs/library/pyb.LED.rst
+++ b/docs/library/pyb.LED.rst
@@ -13,7 +13,7 @@ Constructors
.. class:: pyb.LED(id)
Create an LED object associated with the given LED:
-
+
- ``id`` is the LED number, 1-4.
diff --git a/docs/library/pyb.RTC.rst b/docs/library/pyb.RTC.rst
index 286268655..4c736597c 100644
--- a/docs/library/pyb.RTC.rst
+++ b/docs/library/pyb.RTC.rst
@@ -28,13 +28,13 @@ Methods
.. method:: RTC.datetime([datetimetuple])
Get or set the date and time of the RTC.
-
+
With no arguments, this method returns an 8-tuple with the current
date and time. With 1 argument (being an 8-tuple) it sets the date
and time (and ``subseconds`` is reset to 255).
-
+
The 8-tuple has the following format:
-
+
(year, month, day, weekday, hours, minutes, seconds, subseconds)
``weekday`` is 1-7 for Monday through Sunday.
diff --git a/docs/library/pyb.Timer.rst b/docs/library/pyb.Timer.rst
index 977ba8890..bb7e7e52d 100644
--- a/docs/library/pyb.Timer.rst
+++ b/docs/library/pyb.Timer.rst
@@ -112,7 +112,7 @@ Methods
.. method:: Timer.deinit()
Deinitialises the timer.
-
+
Disables the callback (and the associated irq).
Disables any channel callbacks (and the associated irq).
@@ -191,7 +191,7 @@ Methods
- Read the encoder value using the timer.counter() method.
- Only works on CH1 and CH2 (and not on CH1N or CH2N)
- The channel number is ignored when setting the encoder mode.
-
+
PWM Example::
timer = pyb.Timer(2, freq=1000)
diff --git a/docs/library/pyb.USB_HID.rst b/docs/library/pyb.USB_HID.rst
index 702704435..649dc3df4 100644
--- a/docs/library/pyb.USB_HID.rst
+++ b/docs/library/pyb.USB_HID.rst
@@ -24,11 +24,11 @@ Methods
.. method:: USB_HID.recv(data, \*, timeout=5000)
Receive data on the bus:
-
+
- ``data`` can be an integer, which is the number of bytes to receive,
or a mutable buffer, which will be filled with received bytes.
- ``timeout`` is the timeout in milliseconds to wait for the receive.
-
+
Return value: if ``data`` is an integer then a new buffer of the bytes received,
otherwise the number of bytes read into ``data`` is returned.
diff --git a/docs/library/pyb.USB_VCP.rst b/docs/library/pyb.USB_VCP.rst
index 94ea41848..b16924cf6 100644
--- a/docs/library/pyb.USB_VCP.rst
+++ b/docs/library/pyb.USB_VCP.rst
@@ -92,21 +92,21 @@ Methods
.. method:: USB_VCP.recv(data, \*, timeout=5000)
Receive data on the bus:
-
+
- ``data`` can be an integer, which is the number of bytes to receive,
or a mutable buffer, which will be filled with received bytes.
- ``timeout`` is the timeout in milliseconds to wait for the receive.
-
+
Return value: if ``data`` is an integer then a new buffer of the bytes received,
otherwise the number of bytes read into ``data`` is returned.
.. method:: USB_VCP.send(data, \*, timeout=5000)
Send data over the USB VCP:
-
+
- ``data`` is the data to send (an integer to send, or a buffer object).
- ``timeout`` is the timeout in milliseconds to wait for the send.
-
+
Return value: number of bytes sent.
diff --git a/docs/library/pyb.rst b/docs/library/pyb.rst
index 9ba7e991e..714207ba1 100644
--- a/docs/library/pyb.rst
+++ b/docs/library/pyb.rst
@@ -20,7 +20,7 @@ Time related functions
.. function:: millis()
Returns the number of milliseconds since the board was last reset.
-
+
The result is always a MicroPython smallint (31-bit signed number), so
after 2^30 milliseconds (about 12.4 days) this will start to return
negative numbers.
@@ -32,7 +32,7 @@ Time related functions
.. function:: micros()
Returns the number of microseconds since the board was last reset.
-
+
The result is always a MicroPython smallint (31-bit signed number), so
after 2^30 microseconds (about 17.8 minutes) this will start to return
negative numbers.
@@ -44,10 +44,10 @@ Time related functions
.. function:: elapsed_millis(start)
Returns the number of milliseconds which have elapsed since ``start``.
-
+
This function takes care of counter wrap, and always returns a positive
number. This means it can be used to measure periods up to about 12.4 days.
-
+
Example::
start = pyb.millis()
@@ -57,10 +57,10 @@ Time related functions
.. function:: elapsed_micros(start)
Returns the number of microseconds which have elapsed since ``start``.
-
+
This function takes care of counter wrap, and always returns a positive
number. This means it can be used to measure periods up to about 17.8 minutes.
-
+
Example::
start = pyb.micros()