Skip to content

Commit c121e0a

Browse files
authored
Merge pull request #22 from tekktrik/doc/rtd-formatting
Minor tweaks to RTD fomatting
2 parents a7fa1da + 5e7247c commit c121e0a

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

adafruit_mma8451.py

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,9 @@ def _write_u8(self, address, val):
164164
def range(self):
165165
"""Get and set the range of the sensor. Must be a value of:
166166
167-
- RANGE_8G: +/- 8g
168-
- RANGE_4G: +/- 4g (the default)
169-
- RANGE_2G: +/- 2g
167+
* ``RANGE_8G``: +/- 8g
168+
* ``RANGE_4G``: +/- 4g (the default)
169+
* ``RANGE_2G``: +/- 2g
170170
171171
"""
172172
return self._read_u8(_MMA8451_REG_XYZ_DATA_CFG) & 0x03
@@ -183,14 +183,14 @@ def range(self, val):
183183
def data_rate(self):
184184
"""Get and set the data rate of the sensor. Must be a value of:
185185
186-
- DATARATE_800HZ: 800Hz (the default)
187-
- DATARATE_400HZ: 400Hz
188-
- DATARATE_200HZ: 200Hz
189-
- DATARATE_100HZ: 100Hz
190-
- DATARATE_50HZ: 50Hz
191-
- DATARATE_12_5HZ: 12.5Hz
192-
- DATARATE_6_25HZ: 6.25Hz
193-
- DATARATE_1_56HZ: 1.56Hz
186+
* ``DATARATE_800HZ``: 800Hz (the default)
187+
* ``DATARATE_400HZ``: 400Hz
188+
* ``DATARATE_200HZ``: 200Hz
189+
* ``DATARATE_100HZ``: 100Hz
190+
* ``DATARATE_50HZ``: 50Hz
191+
* ``DATARATE_12_5HZ``: 12.5Hz
192+
* ``DATARATE_6_25HZ``: 6.25Hz
193+
* ``DATARATE_1_56HZ``: 1.56Hz
194194
195195
"""
196196
return (self._read_u8(_MMA8451_REG_CTRL_REG1) >> 3) & _MMA8451_DATARATE_MASK
@@ -245,14 +245,14 @@ def acceleration(self):
245245
def orientation(self):
246246
"""Get the orientation of the MMA8451. Will return a value of:
247247
248-
- PL_PUF: Portrait, up, front
249-
- PL_PUB: Portrait, up, back
250-
- PL_PDF: Portrait, down, front
251-
- PL_PDB: Portrait, down, back
252-
- PL_LRF: Landscape, right, front
253-
- PL_LRB: Landscape, right, back
254-
- PL_LLF: Landscape, left, front
255-
- PL_LLB: Landscape, left, back
248+
* ``PL_PUF``: Portrait, up, front
249+
* ``PL_PUB``: Portrait, up, back
250+
* ``PL_PDF``: Portrait, down, front
251+
* ``PL_PDB``: Portrait, down, back
252+
* ``PL_LRF``: Landscape, right, front
253+
* ``PL_LRB``: Landscape, right, back
254+
* ``PL_LLF``: Landscape, left, front
255+
* ``PL_LLB``: Landscape, left, back
256256
257257
"""
258258
return self._read_u8(_MMA8451_REG_PL_STATUS) & 0x07

0 commit comments

Comments
 (0)