Skip to content

Commit 555aa95

Browse files
JosverlJosverl
committed
Docs: Fix formatting errors in docstrings.
Bumped patch level in manifest for each changed module Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
1 parent 66a6b11 commit 555aa95

File tree

22 files changed

+124
-116
lines changed

22 files changed

+124
-116
lines changed

‎micropython/drivers/imu/bmi270/bmi270.py‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,25 +21,25 @@
2121
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2222
THE SOFTWARE.
2323
24-
Basic example usage:
24+
Basic example usage::
2525
26-
import time
27-
from bmi270 import BMI270
28-
from machine import Pin, SPI, I2C
29-
30-
# Init in I2C mode.
31-
imu = BMI270(I2C(1, scl=Pin(15), sda=Pin(14)))
32-
33-
# Or init in SPI mode.
34-
# TODO: Not supported yet.
35-
# imu = BMI270(SPI(5), cs=Pin(10))
36-
37-
while (True):
38-
print('Accelerometer: x:{:>6.3f} y:{:>6.3f} z:{:>6.3f}'.format(*imu.accel()))
39-
print('Gyroscope: x:{:>6.3f} y:{:>6.3f} z:{:>6.3f}'.format(*imu.gyro()))
40-
print('Magnetometer: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*imu.magnet()))
41-
print("")
42-
time.sleep_ms(100)
26+
import time
27+
from bmi270 import BMI270
28+
from machine import Pin, SPI, I2C
29+
30+
# Init in I2C mode.
31+
imu = BMI270(I2C(1, scl=Pin(15), sda=Pin(14)))
32+
33+
# Or init in SPI mode.
34+
# TODO: Not supported yet.
35+
# imu = BMI270(SPI(5), cs=Pin(10))
36+
37+
while (True):
38+
print('Accelerometer: x:{:>6.3f} y:{:>6.3f} z:{:>6.3f}'.format(*imu.accel()))
39+
print('Gyroscope: x:{:>6.3f} y:{:>6.3f} z:{:>6.3f}'.format(*imu.gyro()))
40+
print('Magnetometer: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*imu.magnet()))
41+
print("")
42+
time.sleep_ms(100)
4343
"""
4444

4545
import array

‎micropython/drivers/imu/bmi270/manifest.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
metadata(description="BOSCH BMI270 IMU driver.", version="1.0.0")
1+
metadata(description="BOSCH BMI270 IMU driver.", version="1.0.1")
22
module("bmi270.py", opt=3)

‎micropython/drivers/imu/bmm150/bmm150.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,22 @@
2121
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2222
THE SOFTWARE.
2323
24-
Basic example usage:
24+
Basic example usage::
2525
26-
import time
27-
from bmm150 import BMM150
28-
from machine import Pin, SPI, I2C
26+
import time
27+
from bmm150 import BMM150
28+
from machine import Pin, SPI, I2C
2929
30-
# Init in I2C mode.
31-
imu = BMM150(I2C(1, scl=Pin(15), sda=Pin(14)))
30+
# Init in I2C mode.
31+
imu = BMM150(I2C(1, scl=Pin(15), sda=Pin(14)))
3232
33-
# Or init in SPI mode.
34-
# TODO: Not supported yet.
35-
# imu = BMM150(SPI(5), cs=Pin(10))
33+
# Or init in SPI mode.
34+
# TODO: Not supported yet.
35+
# imu = BMM150(SPI(5), cs=Pin(10))
3636
37-
while (True):
38-
print('magnetometer: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*imu.magnet()))
39-
time.sleep_ms(100)
37+
while (True):
38+
print('magnetometer: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*imu.magnet()))
39+
time.sleep_ms(100)
4040
"""
4141

4242
import array

‎micropython/drivers/imu/bmm150/manifest.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
metadata(description="BOSCH BMM150 magnetometer driver.", version="1.0.0")
1+
metadata(description="BOSCH BMM150 magnetometer driver.", version="1.0.1")
22
module("bmm150.py", opt=3)

‎micropython/drivers/imu/lsm6dsox/lsm6dsox.py‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,23 @@
2525
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2626
THE SOFTWARE.
2727
28-
Basic example usage:
28+
Basic example usage::
2929
30-
import time
31-
from lsm6dsox import LSM6DSOX
30+
import time
31+
from lsm6dsox import LSM6DSOX
3232
33-
from machine import Pin, SPI, I2C
34-
# Init in I2C mode.
35-
lsm = LSM6DSOX(I2C(0, scl=Pin(13), sda=Pin(12)))
33+
from machine import Pin, SPI, I2C
34+
# Init in I2C mode.
35+
lsm = LSM6DSOX(I2C(0, scl=Pin(13), sda=Pin(12)))
3636
37-
# Or init in SPI mode.
38-
#lsm = LSM6DSOX(SPI(5), cs=Pin(10))
37+
# Or init in SPI mode.
38+
#lsm = LSM6DSOX(SPI(5), cs=Pin(10))
3939
40-
while (True):
41-
print('Accelerometer: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*lsm.accel()))
42-
print('Gyroscope: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*lsm.gyro()))
43-
print("")
44-
time.sleep_ms(100)
40+
while (True):
41+
print('Accelerometer: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*lsm.accel()))
42+
print('Gyroscope: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*lsm.gyro()))
43+
print("")
44+
time.sleep_ms(100)
4545
"""
4646

4747
import array

‎micropython/drivers/imu/lsm6dsox/manifest.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
metadata(description="ST LSM6DSOX imu driver.", version="1.0.1")
1+
metadata(description="ST LSM6DSOX imu driver.", version="1.0.2")
22
module("lsm6dsox.py", opt=3)

‎micropython/drivers/imu/lsm9ds1/lsm9ds1.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,21 @@
2727
The sensor contains an accelerometer / gyroscope / magnetometer
2828
Uses the internal FIFO to store up to 16 gyro/accel data, use the iter_accel_gyro generator to access it.
2929
30-
Example usage:
30+
Example usage::
3131
32-
import time
33-
from lsm9ds1 import LSM9DS1
34-
from machine import Pin, I2C
32+
import time
33+
from lsm9ds1 import LSM9DS1
34+
from machine import Pin, I2C
3535
36-
imu = LSM9DS1(I2C(1, scl=Pin(15), sda=Pin(14)))
36+
imu = LSM9DS1(I2C(1, scl=Pin(15), sda=Pin(14)))
3737
38-
while (True):
39-
#for g,a in imu.iter_accel_gyro(): print(g,a) # using fifo
40-
print('Accelerometer: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*imu.accel()))
41-
print('Magnetometer: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*imu.magnet()))
42-
print('Gyroscope: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*imu.gyro()))
43-
print("")
44-
time.sleep_ms(100)
38+
while (True):
39+
#for g,a in imu.iter_accel_gyro(): print(g,a) # using fifo
40+
print('Accelerometer: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*imu.accel()))
41+
print('Magnetometer: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*imu.magnet()))
42+
print('Gyroscope: x:{:>8.3f} y:{:>8.3f} z:{:>8.3f}'.format(*imu.gyro()))
43+
print("")
44+
time.sleep_ms(100)
4545
"""
4646

4747
import array

‎micropython/drivers/imu/lsm9ds1/manifest.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
metadata(description="Driver for ST LSM9DS1 IMU.", version="1.0.0")
1+
metadata(description="Driver for ST LSM9DS1 IMU.", version="1.0.1")
22
module("lsm9ds1.py", opt=3)

‎micropython/drivers/sensor/ds18x20/ds18x20.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
# DS18x20 temperature sensor driver for MicroPython.
2-
# MIT license; Copyright (c) 2016 Damien P. George
1+
"""DS18x20 temperature sensor driver for MicroPython.
2+
3+
MIT license; Copyright (c) 2016 Damien P. George
4+
"""
35

46
from micropython import const
57

‎micropython/drivers/sensor/ds18x20/manifest.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
metadata(description="DS18x20 temperature sensor driver.", version="0.1.0")
1+
metadata(description="DS18x20 temperature sensor driver.", version="0.1.1")
22

33
require("onewire")
44
module("ds18x20.py", opt=3)

0 commit comments

Comments
 (0)