aboutsummaryrefslogtreecommitdiff
path: root/docs/source/lang/api/isbuttonpressed.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-05-09 16:43:27 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-05-09 16:49:08 -0400
commitb8b2607ad117822f5eba4224965cbf0456ac8a0d (patch)
tree8bcf39c3c32905f6aaf64e4b7199c1edd1c7f752 /docs/source/lang/api/isbuttonpressed.rst
parent5df53a5274cb29fd66aecdbb06f49c1d0369476d (diff)
parenta00029e1325393d779bd5294efc86a990ba0521b (diff)
Merge branch 'refactor'
This merges the libmaple refactor work into master. The contents of libmaple proper (/libmaple/) are almost completely incompatible with previous APIs in master. See /docs/source/libmaple/overview.rst for more information on the new design. Wirish incompatibilities are limited to the HardwareTimer class; however, there are several new deprecations, most likely to be removed in 0.1.0.
Diffstat (limited to 'docs/source/lang/api/isbuttonpressed.rst')
-rw-r--r--docs/source/lang/api/isbuttonpressed.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/source/lang/api/isbuttonpressed.rst b/docs/source/lang/api/isbuttonpressed.rst
index dbff0c9..8c350b9 100644
--- a/docs/source/lang/api/isbuttonpressed.rst
+++ b/docs/source/lang/api/isbuttonpressed.rst
@@ -4,7 +4,8 @@ isButtonPressed()
=================
Check whether the board's built-in button (labeled BUT on the
-silkscreen) is pressed.
+silkscreen) is pressed. The pin number of the built-in button is
+given by the constant ``BOARD_BUTTON_PIN``.
Library Documentation
---------------------
@@ -14,4 +15,6 @@ Library Documentation
See Also
--------
+- :ref:`Board-specific values <lang-board-values>`
+- :ref:`BOARD_BUTTON_PIN <lang-board-values-but>`
- :ref:`lang-waitforbuttonpress`