summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Halbert <halbert@halwitz.org>2019-01-09 19:59:48 -0500
committerDan Halbert <halbert@halwitz.org>2019-01-09 19:59:48 -0500
commitd3b8581ce02e38ab7aad0ad931b97b789ae2e946 (patch)
tree9821b9c7b5fad686719dbe082832b8e4d660284f
parent382467904a139161fec2230a6ac7e320772315f1 (diff)
parentdabb8ffdaa46ae84d0cdbd00511da9300a4dc8df (diff)
fix merge conflicts; address some comments
-rwxr-xr-x.travis.yml2
-rw-r--r--conf.py6
-rw-r--r--ports/nrf/README.md6
-rw-r--r--shared-bindings/bleio/Broadcaster.c5
-rw-r--r--shared-bindings/bleio/CharacteristicBuffer.c2
5 files changed, 11 insertions, 10 deletions
diff --git a/.travis.yml b/.travis.yml
index eb1a41e64..6c141385b 100755
--- a/.travis.yml
+++ b/.travis.yml
@@ -74,7 +74,7 @@ before_script:
- sudo apt-get install -y python3-pip
- pip3 install --user sh click
- ([[ -z "$TRAVIS_TESTS" ]] || sudo pip install --upgrade cpp-coveralls)
- - (! var_search "${TRAVIS_TESTS-}" docs || pip install --user 'Sphinx<1.8.0' sphinx-rtd-theme 'recommonmark<0.5.0')
+ - (! var_search "${TRAVIS_TESTS-}" docs || pip install --user Sphinx sphinx-rtd-theme recommonmark)
- (! var_search "${TRAVIS_TESTS-}" translations || pip3 install --user polib)
# report some good version numbers to the build
diff --git a/conf.py b/conf.py
index dcfaa2678..4da3c2686 100644
--- a/conf.py
+++ b/conf.py
@@ -284,7 +284,7 @@ latex_elements = {
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'CircuitPython.tex', 'CircuitPython Documentation',
- 'Damien P. George, Paul Sokolovsky, and contributors', 'manual'),
+ 'CircuitPython Contributors', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@@ -314,7 +314,7 @@ latex_documents = [
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'CircuitPython', 'CircuitPython Documentation',
- ['Damien P. George, Paul Sokolovsky, and contributors'], 1),
+ ['CircuitPython contributors'], 1),
]
# If true, show URL addresses after external links.
@@ -328,7 +328,7 @@ man_pages = [
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'CircuitPython', 'CircuitPython Documentation',
- 'Damien P. George, Paul Sokolovsky, and contributors', 'CircuitPython', 'One line description of project.',
+ 'CircuitPython contributors', 'CircuitPython', 'Python for Microcontrollers.',
'Miscellaneous'),
]
diff --git a/ports/nrf/README.md b/ports/nrf/README.md
index e909368b6..9413174bf 100644
--- a/ports/nrf/README.md
+++ b/ports/nrf/README.md
@@ -33,9 +33,9 @@ the following links:
> **NOTE**: These board specific readmes may be more up to date than the
generic board-neutral documentation further down.
-* Adafruit [Feather nRF52840](boards/feather_nrf52840_express/README.md): 1MB Flash, 256KB SRAM
-* Nordic PCA10056 see [Feather nRF52840](boards/pca10056/README.md)
-* MakerDiary NRF52840 MDK see [its README](boards/makerdiary_nrf52840_mdk/README.md)
+* Adafruit Feather nRF52840: `boards/feather_nrf52840_express/README.md`: 1MB Flash, 256KB SRAM
+* Nordic PCA10056 (uses nRF52840): `boards/pca10056/README.md`
+* MakerDiary NRF52840 MDK: `boards/makerdiary_nrf52840_mdk/README.md`
For all other board targets, see the generic notes below.
diff --git a/shared-bindings/bleio/Broadcaster.c b/shared-bindings/bleio/Broadcaster.c
index c4524e8fc..c46de1d35 100644
--- a/shared-bindings/bleio/Broadcaster.c
+++ b/shared-bindings/bleio/Broadcaster.c
@@ -31,7 +31,7 @@
//| .. currentmodule:: bleio
//|
-//| :class:`Broadcaster` -- A GAP Broadcaster
+//| :class:`Broadcaster` -- Broadcast advertising packets.
//| =========================================================
//|
//| Implement a BLE broadcaster which sends data in advertising packets and does not connect.
@@ -44,12 +44,13 @@
//|
//| # Broadcast once a second.
//| broadcaster = bleio.Broadcaster(interval=1)
-//| i = 0
+//| data = 0
//| # Broadcast a byte of data that's incremented once a minute
//| while True:
//| # data is an entire advertising data packet, starting with flags.
//| broadcaster.start_advertising(data)
//| time.sleep(60)
+//| data += 1
//|
//| .. class:: Broadcaster(interval=1)
//|
diff --git a/shared-bindings/bleio/CharacteristicBuffer.c b/shared-bindings/bleio/CharacteristicBuffer.c
index d28cd54cf..f0578a7ad 100644
--- a/shared-bindings/bleio/CharacteristicBuffer.c
+++ b/shared-bindings/bleio/CharacteristicBuffer.c
@@ -31,7 +31,7 @@
//| .. currentmodule:: bleio
//|
-//| :class:`CharacteristicBuffer` -- GATT Service incoming values buffer.
+//| :class:`CharacteristicBuffer` -- BLE Service incoming values buffer.
//| =====================================================================
//|
//| Accumulates a Characteristic's incoming values in a FIFO buffer.