fix merge conflicts; address some comments

This commit is contained in:
Dan Halbert 2019-01-09 19:59:48 -05:00
commit d3b8581ce0
5 changed files with 11 additions and 10 deletions

View File

@ -74,7 +74,7 @@ before_script:
- sudo apt-get install -y python3-pip - sudo apt-get install -y python3-pip
- pip3 install --user sh click - pip3 install --user sh click
- ([[ -z "$TRAVIS_TESTS" ]] || sudo pip install --upgrade cpp-coveralls) - ([[ -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) - (! var_search "${TRAVIS_TESTS-}" translations || pip3 install --user polib)
# report some good version numbers to the build # report some good version numbers to the build

View File

@ -284,7 +284,7 @@ latex_elements = {
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'CircuitPython.tex', 'CircuitPython Documentation', (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 # 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). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'CircuitPython', 'CircuitPython Documentation', ('index', 'CircuitPython', 'CircuitPython Documentation',
['Damien P. George, Paul Sokolovsky, and contributors'], 1), ['CircuitPython contributors'], 1),
] ]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
@ -328,7 +328,7 @@ man_pages = [
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'CircuitPython', 'CircuitPython Documentation', (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'), 'Miscellaneous'),
] ]

View File

@ -33,9 +33,9 @@ the following links:
> **NOTE**: These board specific readmes may be more up to date than the > **NOTE**: These board specific readmes may be more up to date than the
generic board-neutral documentation further down. generic board-neutral documentation further down.
* Adafruit [Feather nRF52840](boards/feather_nrf52840_express/README.md): 1MB Flash, 256KB SRAM * Adafruit Feather nRF52840: `boards/feather_nrf52840_express/README.md`: 1MB Flash, 256KB SRAM
* Nordic PCA10056 see [Feather nRF52840](boards/pca10056/README.md) * Nordic PCA10056 (uses nRF52840): `boards/pca10056/README.md`
* MakerDiary NRF52840 MDK see [its README](boards/makerdiary_nrf52840_mdk/README.md) * MakerDiary NRF52840 MDK: `boards/makerdiary_nrf52840_mdk/README.md`
For all other board targets, see the generic notes below. For all other board targets, see the generic notes below.

View File

@ -31,7 +31,7 @@
//| .. currentmodule:: bleio //| .. 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. //| Implement a BLE broadcaster which sends data in advertising packets and does not connect.
@ -44,12 +44,13 @@
//| //|
//| # Broadcast once a second. //| # Broadcast once a second.
//| broadcaster = bleio.Broadcaster(interval=1) //| broadcaster = bleio.Broadcaster(interval=1)
//| i = 0 //| data = 0
//| # Broadcast a byte of data that's incremented once a minute //| # Broadcast a byte of data that's incremented once a minute
//| while True: //| while True:
//| # data is an entire advertising data packet, starting with flags. //| # data is an entire advertising data packet, starting with flags.
//| broadcaster.start_advertising(data) //| broadcaster.start_advertising(data)
//| time.sleep(60) //| time.sleep(60)
//| data += 1
//| //|
//| .. class:: Broadcaster(interval=1) //| .. class:: Broadcaster(interval=1)
//| //|

View File

@ -31,7 +31,7 @@
//| .. currentmodule:: bleio //| .. 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. //| Accumulates a Characteristic's incoming values in a FIFO buffer.