aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-04-25 18:13:47 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-04-25 18:53:01 -0400
commit0d2f2ac040706acd164e5c6296ce6ae9bd5da20f (patch)
tree5f6b6a7408fc67f326246afd9eddde230f444e4b
parentac509ea796f907dc27841a1e4cfa74c2a3285d6a (diff)
downloadlibrambutan-0d2f2ac040706acd164e5c6296ce6ae9bd5da20f.tar.gz
librambutan-0d2f2ac040706acd164e5c6296ce6ae9bd5da20f.zip
Docs tweaks.
Blocking fixes for 0.0.10; other changes.
-rw-r--r--docs/source/conf.py2
-rw-r--r--docs/source/lang/api/serial.rst8
-rw-r--r--docs/source/libs/servo.rst2
3 files changed, 7 insertions, 5 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py
index f232b7c..baadccb 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -59,7 +59,7 @@ copyright = u'2010, LeafLabs, LLC'
# The short X.Y version.
version = '0.0'
# The full version, including alpha/beta/rc tags.
-release = '0.0.9'
+release = '0.0.10'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/docs/source/lang/api/serial.rst b/docs/source/lang/api/serial.rst
index fadac34..417063d 100644
--- a/docs/source/lang/api/serial.rst
+++ b/docs/source/lang/api/serial.rst
@@ -12,8 +12,8 @@ devices.
Introduction
------------
-.. FIXME remove Maple-specific documentation
-.. FIXME Serial4, Serial5 updates for high-density devices
+.. FIXME [Maple-specific values]
+.. FIXME [0.0.10] Serial4, Serial5 updates for high-density devices
The Maple has three serial ports (also known as a UARTs or USARTs):
``Serial1``, ``Serial2``, and ``Serial3``. They communicate using the
@@ -90,7 +90,7 @@ means that you can use any of these functions on any of ``Serial1``,
.. cpp:function:: HardwareSerial::flush()
- Removes the contents of the Serial's associated USART RX FIFO.
+ Throw away the contents of the serial port's receiver (RX) buffer.
That is, clears any buffered characters, so that the next character
read is guaranteed to be new.
@@ -213,7 +213,7 @@ the USB port on the Maple board (for that, use :ref:`SerialUSB
<lang-serialusb>`). Thus, to use these pins to communicate with your
personal computer, you will need an additional USB-to-serial adapter.
-.. TODO LATER port these examples over
+.. FIXME [0.1.0] port these examples over
.. Examples
.. --------
diff --git a/docs/source/libs/servo.rst b/docs/source/libs/servo.rst
index f92fd91..475f7dd 100644
--- a/docs/source/libs/servo.rst
+++ b/docs/source/libs/servo.rst
@@ -6,6 +6,8 @@
Servo
=======
+.. FIXME [0.0.10] this is out of date
+
This documents the Servo library for controlling RC servomotors. It
is implemented as a thin layer over the built-in :ref:`timer
peripherals <timers>`.