Skip to content

Commit 2b4242e

Browse files
committed
sphinx fixes; docstring formatting2
1 parent 94b454d commit 2b4242e

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

adafruit_lis3dh.py

+5
Original file line numberDiff line numberDiff line change
@@ -167,13 +167,16 @@ def acceleration(self):
167167
def shake(self, shake_threshold=30, avg_count=10, total_delay=0.1):
168168
"""
169169
Detect when the accelerometer is shaken. Optional parameters:
170+
170171
:param shake_threshold: Increase or decrease to change shake sensitivity. This
171172
requires a minimum value of 10. 10 is the total
172173
acceleration if the board is not moving, therefore
173174
anything less than 10 will erroneously report a constant
174175
shake detected. (Default 30)
176+
175177
:param avg_count: The number of readings taken and used for the average
176178
acceleration. (Default 10)
179+
177180
:param total_delay: The total time in seconds it takes to obtain avg_count
178181
readings from acceleration. (Default 0.1)
179182
"""
@@ -254,10 +257,12 @@ def set_tap(self, tap, threshold, *,
254257
255258
:param int tap: 0 to disable tap detection, 1 to detect only single
256259
taps, and 2 to detect only double taps.
260+
257261
:param int threshold: A threshold for the tap detection. The higher the value
258262
the less sensitive the detection. This changes based on
259263
the accelerometer range. Good values are 5-10 for 16G,
260264
10-20 for 8G, 20-40 for 4G, and 40-80 for 2G.
265+
261266
:param int time_limit: TIME_LIMIT register value (default 10).
262267
:param int time_latency: TIME_LATENCY register value (default 20).
263268
:param int time_window: TIME_WINDOW register value (default 255).

0 commit comments

Comments
 (0)