Skip to content

Commit 88cbf77

Browse files
committed
canio.CAN: clarify read-only status of several properties
1 parent d79f4e2 commit 88cbf77

File tree

1 file changed

+5
-3
lines changed
  • shared-bindings/canio

1 file changed

+5
-3
lines changed

shared-bindings/canio/CAN.c

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ STATIC const mp_obj_property_t canio_can_receive_error_count_obj = {
172172
};
173173

174174
//| state: State
175-
//| """The current state of the bus."""
175+
//| """The current state of the bus. (read-only)"""
176176
STATIC mp_obj_t canio_can_state_get(mp_obj_t self_in) {
177177
canio_can_obj_t *self = MP_OBJ_TO_PTR(self_in);
178178
common_hal_canio_can_check_for_deinit(self);
@@ -256,7 +256,8 @@ STATIC mp_obj_t canio_can_listen(size_t n_args, const mp_obj_t *pos_args, mp_map
256256
MP_DEFINE_CONST_FUN_OBJ_KW(canio_can_listen_obj, 1, canio_can_listen);
257257

258258
//| loopback: bool
259-
//| """True if the device was created in loopback mode, False otherwise"""
259+
//| """True if the device was created in loopback mode, False
260+
//| otherwise (read-only)"""
260261
//|
261262
STATIC mp_obj_t canio_can_loopback_get(mp_obj_t self_in) {
262263
canio_can_obj_t *self = MP_OBJ_TO_PTR(self_in);
@@ -294,7 +295,8 @@ STATIC mp_obj_t canio_can_send(mp_obj_t self_in, mp_obj_t message_in) {
294295
MP_DEFINE_CONST_FUN_OBJ_2(canio_can_send_obj, canio_can_send);
295296

296297
//| silent: bool
297-
//| """True if the device was created in silent mode, False otherwise"""
298+
//| """True if the device was created in silent mode, False
299+
//| otherwise (read-only)"""
298300
//|
299301
STATIC mp_obj_t canio_can_silent_get(mp_obj_t self_in) {
300302
canio_can_obj_t *self = MP_OBJ_TO_PTR(self_in);

0 commit comments

Comments
 (0)