aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/lang/api')
-rw-r--r--docs/source/lang/api/analogread.rst5
-rw-r--r--docs/source/lang/api/board-values.rst8
-rw-r--r--docs/source/lang/api/disabledebugports.rst4
-rw-r--r--docs/source/lang/api/pwmwrite.rst5
4 files changed, 11 insertions, 11 deletions
diff --git a/docs/source/lang/api/analogread.rst b/docs/source/lang/api/analogread.rst
index 6665a94..59eab79 100644
--- a/docs/source/lang/api/analogread.rst
+++ b/docs/source/lang/api/analogread.rst
@@ -40,9 +40,8 @@ listed underneath their number on your board's silkscreen. These pin
numbers are available to your program in the :ref:`boardADCPins
<lang-board-values-adc-pins>` board-specific array. The number of
pins which are capable of analog to digital conversion on your board
-is given by the ``BOARD_NR_ADC_PINS`` constant. These values are
-documented for each board in the :ref:`Board Hardware Documentation
-<index-boards>` pages.
+is given by the ``BOARD_NR_ADC_PINS`` constant. See your board's
+documentation for these values.
.. note:: Pin 3 is not marked ``AIN`` on the silkscreen for Maple
revisions through Rev 5; however **it does work** as an analog
diff --git a/docs/source/lang/api/board-values.rst b/docs/source/lang/api/board-values.rst
index d944c8d..70eff60 100644
--- a/docs/source/lang/api/board-values.rst
+++ b/docs/source/lang/api/board-values.rst
@@ -7,8 +7,8 @@ Board-Specific Values
There are a number of board-specific values: constants or variables
which are different depending on which LeafLabs board you have. The
-exact values for each board are given in your :ref:`board's hardware
-documentation <index-boards>`.
+exact values for each board are given in your board's hardware
+documentation.
This page lists and documents the board-specific values. You should
use these when appropriate in your own programs. This will help make
@@ -122,8 +122,8 @@ Constants
<lang-board-values-used-pins>`). However, they can be used as
ordinary GPIOs if you call the :ref:`lang-disabledebugports`
function. (Be careful with this on the Maple and Maple RET6
- Edition, as writing to ``BOARD_NJTRST_PIN`` :ref:`may cause your
- board to reset <maple-nrst-pb4>`\ !).
+ Edition, as writing to ``BOARD_NJTRST_PIN`` may cause your
+ board to reset!).
.. _lang-board-values-pwm-pins:
diff --git a/docs/source/lang/api/disabledebugports.rst b/docs/source/lang/api/disabledebugports.rst
index 283cdbf..071d4c3 100644
--- a/docs/source/lang/api/disabledebugports.rst
+++ b/docs/source/lang/api/disabledebugports.rst
@@ -30,4 +30,6 @@ See Also
--------
- :ref:`lang-enabledebugports`
-- :ref:`Important erratum on Maple pin 43 <maple-nrst-pb4>`
+- Important erratum on Maple pin 43
+
+.. TODO direct off-site link to <maple-nrst-pb4>
diff --git a/docs/source/lang/api/pwmwrite.rst b/docs/source/lang/api/pwmwrite.rst
index 5cc112e..aa39ab1 100644
--- a/docs/source/lang/api/pwmwrite.rst
+++ b/docs/source/lang/api/pwmwrite.rst
@@ -15,9 +15,8 @@ The pins which support PWM have ``PWM`` listed underneath their number
on your board's silkscreen. These pin numbers are available to your
program in the :ref:`boardPWMPins <lang-board-values-pwm-pins>`
board-specific array. The number of pins which are capable of PWM on
-your board is given by the ``BOARD_NR_PWM_PINS`` constant. These
-values are documented for each board in the :ref:`Board Hardware
-Documentation <index-boards>` pages.
+your board is given by the ``BOARD_NR_PWM_PINS`` constant. See your
+board's documentation for these values.
The Arduino function :ref:`analogWrite() <lang-analogwrite>` is an
alias for ``pwmWrite()``, but it is badly named, and its use is