Skip to content

Commit 3a228dc

Browse files
committed
more sphinx fixes
1 parent 115985c commit 3a228dc

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

adafruit_veml6070.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
# CircuitPython Library Author: Michael Schroeder(sommersoft). No
2020
# affiliation to Adafruit is implied.
2121
"""
22-
`adafruit_VEML6070` - VEML6070 UV Sensor
22+
`adafruit_veml6070` - VEML6070 UV Sensor
2323
====================================================
2424
2525
CircuitPython library to support VEML6070 UV Index sensor.
@@ -89,9 +89,9 @@ class VEML6070:
8989
Defaults to `VEML6070_1_T` if parameter not passed. To change
9090
setting after intialization, use
9191
`[veml6070].set_integration_time(new_it)`.
92-
:param bool ack: The inital setting of `ACKnowledge` on alert. Defaults to `False`
92+
:param bool ack: The inital setting of ``ACKnowledge`` on alert. Defaults to `False`
9393
if parameter not passed. To change setting after intialization,
94-
use `[veml6070].set_ack(new_ack)`.
94+
use ``[veml6070].set_ack(new_ack)``.
9595
9696
Example:
9797
@@ -165,7 +165,7 @@ def set_ack(self, new_ack=False):
165165
"""
166166
Turns on or off the ACKnowledge function of the sensor. The ACK function will send
167167
a signal to the host when the value of the sensed UV light changes beyond the
168-
programmed threshold. Use `[veml6070].set_ack_threshold` to change between the two
168+
programmed threshold. Use ``[veml6070].set_ack_threshold`` to change between the two
169169
available threshold settings.
170170
"""
171171
if new_ack not in (True, False):
@@ -179,8 +179,8 @@ def set_ack(self, new_ack=False):
179179
def set_ack_threshold(self, new_ack_thd=0):
180180
"""
181181
Sets the ACKnowledge Threshold, which alerts the host controller to value changes
182-
greater than the threshold. Available settings are: `0` = 102 steps; `1` = 145 steps.
183-
`0` is the default setting.
182+
greater than the threshold. Available settings are: ``0`` = 102 steps; ``1`` = 145 steps.
183+
``0`` is the default setting.
184184
"""
185185
if new_ack_thd not in (0, 1):
186186
raise ValueError("ACK Threshold must be '0' or '1'.")
@@ -219,7 +219,7 @@ def sleep(self):
219219

220220
def wake(self):
221221
"""
222-
Wakes the VEML6070 from sleep. `[veml6070].read` will also wake from sleep.
222+
Wakes the VEML6070 from sleep. ``[veml6070].read`` will also wake from sleep.
223223
"""
224224
self.buf[0] = (self._ack << 5 | self._ack_thd << 4 |
225225
_VEML6070_INTEGRATION_TIME[self._it][0] << 2 | 0x02)
@@ -229,7 +229,7 @@ def wake(self):
229229
def get_index(self, _raw):
230230
"""
231231
Calculates the UV Risk Level based on the captured UV reading. Requres the `_raw`
232-
argument (from `veml6070.read`). Risk level is available for Integration Times (IT)
232+
argument (from ``veml6070.read``). Risk level is available for Integration Times (IT)
233233
1, 2, & 4. The result is automatically scaled to the current IT setting.
234234
235235
LEVEL* UV Index

0 commit comments

Comments
 (0)