Skip to content

Commit 554d783

Browse files
committed
sphinx fixes
1 parent 5e56b19 commit 554d783

File tree

3 files changed

+8
-14
lines changed

3 files changed

+8
-14
lines changed

README.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,6 @@ To install in a virtual environment in your current project:
5353
source .env/bin/activate
5454
pip3 install adafruit-circuitpython-ble-heart-rate
5555
56-
Usage Example
57-
=============
58-
59-
.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
60-
6156
Contributing
6257
============
6358

adafruit_ble_heart_rate.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,13 @@ def __init__(self, service=None):
110110
@property
111111
def measurement_values(self):
112112
"""All the measurement values, as a tuple:
113-
(heart_rate: int (beats per minute),
114-
contact: True if contacting, False if not, None if unknown,
115-
energy_expended: int (Kilo joules), or None if no value,
116-
rr_intervals: list of RR-intervals, if any,
117-
oldest first, in ints that are1024ths of a second,
118-
)
113+
(heart_rate, contact, energy_expended, rr_intervals)
114+
* heart_rate: int (beats per minute)
115+
* contact: True if contacting, False if not, None if unknown
116+
* energy_expended: int (Kilo joules), or None if no value
117+
* rr_intervals: list of RR-intervals, if any,
118+
oldest first, in ints that are1024ths of a second,
119+
119120
Return None if no packet has been read yet.
120121
"""
121122
buf = self._measurement_buf

docs/index.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@ Table of Contents
2626
.. toctree::
2727
:caption: Related Products
2828

29-
Tested on a Scosche Rhythm+ Armband Heart Rate Monitor, but should be usable
30-
with other standard BLE Heart Rate Monitors.
31-
<https://www.amazon.com/gp/product/B00JQHTJS2>
29+
Scosche Rhythm+ Armband Heart Rate Monitor (should be usable with others) <https://www.amazon.com/gp/product/B00JQHTJS2>
3230

3331
.. toctree::
3432
:caption: Other Links

0 commit comments

Comments
 (0)