Skip to content

Commit a1aac92

Browse files
sebromeroactions-user
authored andcommitted
Update documentation
1 parent b12726f commit a1aac92

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/api.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,10 @@ or if a custom one was set.
223223
def available_devices()
224224
```
225225

226-
Finds all devices on the i2c bus and returns a list of Modulino objects.
226+
Finds all devices on the i2c bus and returns them as a list of Modulino objects.
227+
228+
Returns:
229+
list: A list of Modulino objects.
227230

228231
<a id="modulino.modulino.Modulino.reset_bus"></a>
229232

@@ -238,8 +241,7 @@ Resets the i2c bus. This is useful when the bus is in an unknown state.
238241
The modulinos that are equipped with a micro controller use DMA operations.
239242
If the host board does a reset during such operation it can make the bus get stuck.
240243

241-
Returns
242-
----
244+
Returns:
243245
I2C: A new i2c bus object after resetting the bus.
244246

245247
<a id="modulino.pixels.ModulinoColor"></a>

0 commit comments

Comments
 (0)