stmhal: Fix typos in class documentation.

dpgeorge · dpgeorge · commit baa2afbb58b8 · 2014-05-03T16:42:27.000+01:00
diff --git 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
@@ -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
@@ -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
@@ -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:
 ///

Original file line number	Diff line number	Diff line change
`@@ -367,7 +367,7 @@ STATIC mp_obj_t pyb_i2c_send(uint n_args, const mp_obj_t args, mp_map_t kw_arg`
`367`	`367`	`}`
`368`	`368`	`STATIC MP_DEFINE_CONST_FUN_OBJ_KW(pyb_i2c_send_obj, 1, pyb_i2c_send);`
`369`	`369`
`370`		`-/// \method recv(send, addr=0x00, timeout=5000)`
	`370`	`+/// \method recv(recv, addr=0x00, timeout=5000)`
`371`	`371`	`///`
`372`	`372`	`/// Receive data on the bus:`
`373`	`373`	`///`
Original file line number	Diff line number	Diff line change
`@@ -198,7 +198,7 @@ STATIC void pyb_spi_print(void (print)(void env, const char fmt, ...), void `
`198`	`198`	`}`
`199`	`199`	`}`
`200`	`200`
`201`		`-/// \method init(mode, baudrate=328125, *, polarity=1, phase=1, bits=8, firstbit=SPI.MSB, ti=false, crc=None)`
	`201`	`+/// \method init(mode, baudrate=328125, *, polarity=1, phase=1, bits=8, firstbit=SPI.MSB, ti=False, crc=None)`
`202`	`202`	`///`
`203`	`203`	`/// Initialise the SPI bus with the given parameters:`
`204`	`204`	`///`