Skip to content

Commit 566628f

Browse files
committed
Add additional documentation to docstrings
1 parent 977d435 commit 566628f

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

adafruit_mlx90393.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,9 @@ class MLX90393: # pylint: disable=too-many-instance-attributes
169169
:param i2c_bus: The I2C bus the device is connected to
170170
:param int address: The I2C device address. Defaults to :const:`0x0C`
171171
:param int gain: The gain level to apply. Defaults to :const:`GAIN_1X`
172+
:param int resolution: The resolution level to use. Defaults to :const:`RESOLUTION_16`
173+
:param int filt: The filter to use. Defaults to :const:`FILTER_7`
174+
:param int oversampling: The oversampleing setting to use. Defaults to :const:`OSR_3`
172175
:param bool debug: Enable debug output. Defaults to `False`
173176
174177
@@ -399,6 +402,8 @@ def display_status(self) -> None:
399402
def read_reg(self, reg: int) -> int:
400403
"""
401404
Gets the current value of the specified register.
405+
406+
:param int reg: The register to read
402407
"""
403408
# Write 'value' to the specified register
404409
payload = bytes([_CMD_RR, reg << 2])
@@ -421,6 +426,9 @@ def read_reg(self, reg: int) -> int:
421426
def write_reg(self, reg: int, value: int) -> None:
422427
"""
423428
Writes the 16-bit value to the supplied register.
429+
430+
:param int reg: The register to write to
431+
:param int value: The value to write to the register
424432
"""
425433
self._transceive(
426434
bytes(

0 commit comments

Comments
 (0)