diff options
| author | Damien George <damien.p.george@gmail.com> | 2014-05-03 16:42:27 +0100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2014-05-03 16:42:27 +0100 |
| commit | baa2afbb58b81978e81cc10a100c74b6b3ec6b6c (patch) | |
| tree | a328406a9d43ee39d260f82796275cecef3f3fa7 /stmhal | |
| parent | 16d58fc78725647628c18d7cce9fda6f72dc68a3 (diff) | |
| download | micropython-baa2afbb58b81978e81cc10a100c74b6b3ec6b6c.tar.gz micropython-baa2afbb58b81978e81cc10a100c74b6b3ec6b6c.zip | |
stmhal: Fix typos in class documentation.
Diffstat (limited to 'stmhal')
| -rw-r--r-- | stmhal/i2c.c | 2 | ||||
| -rw-r--r-- | stmhal/pin.c | 1 | ||||
| -rw-r--r-- | stmhal/servo.c | 1 | ||||
| -rw-r--r-- | stmhal/spi.c | 2 |
4 files changed, 4 insertions, 2 deletions
diff --git a/stmhal/i2c.c b/stmhal/i2c.c index b8de855304..96222bf336 100644 --- a/stmhal/i2c.c +++ b/stmhal/i2c.c @@ -367,7 +367,7 @@ STATIC mp_obj_t pyb_i2c_send(uint n_args, const mp_obj_t *args, mp_map_t *kw_arg } STATIC MP_DEFINE_CONST_FUN_OBJ_KW(pyb_i2c_send_obj, 1, pyb_i2c_send); -/// \method recv(send, addr=0x00, timeout=5000) +/// \method recv(recv, addr=0x00, timeout=5000) /// /// Receive data on the bus: /// diff --git a/stmhal/pin.c b/stmhal/pin.c index 5b0f998de6..d390926360 100644 --- a/stmhal/pin.c +++ b/stmhal/pin.c @@ -241,6 +241,7 @@ STATIC MP_DEFINE_CONST_CLASSMETHOD_OBJ(pin_debug_obj, (mp_obj_t)&pin_debug_fun_o /// - `Pin.PULL_DOWN` - enable the pull-down resistor. /// /// Returns: `None`. +// TODO allow keyword args STATIC mp_obj_t pin_obj_init(uint n_args, mp_obj_t *args) { pin_obj_t *self = args[0]; diff --git a/stmhal/servo.c b/stmhal/servo.c index 68e211bcb3..6f87197bd2 100644 --- a/stmhal/servo.c +++ b/stmhal/servo.c @@ -203,6 +203,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(pyb_servo_pulse_width_obj, 1, 2, pyb_ /// \method calibration([pulse_min, pulse_max, pulse_centre, [pulse_angle_90, pulse_speed_100]]) /// Get or set the calibration of the servo timing. +// TODO should accept 1 arg, a 5-tuple of values to set STATIC mp_obj_t pyb_servo_calibration(uint n_args, const mp_obj_t *args) { pyb_servo_obj_t *self = args[0]; if (n_args == 1) { diff --git a/stmhal/spi.c b/stmhal/spi.c index c1b8e75d05..a07ebd21a9 100644 --- a/stmhal/spi.c +++ b/stmhal/spi.c @@ -198,7 +198,7 @@ STATIC void pyb_spi_print(void (*print)(void *env, const char *fmt, ...), void * } } -/// \method init(mode, baudrate=328125, *, polarity=1, phase=1, bits=8, firstbit=SPI.MSB, ti=false, crc=None) +/// \method init(mode, baudrate=328125, *, polarity=1, phase=1, bits=8, firstbit=SPI.MSB, ti=False, crc=None) /// /// Initialise the SPI bus with the given parameters: /// |