summaryrefslogtreecommitdiff
path: root/shared-bindings
diff options
context:
space:
mode:
authorJeff Epler <jepler@gmail.com>2020-09-29 20:13:52 -0500
committerJeff Epler <jepler@gmail.com>2020-09-29 20:13:52 -0500
commit88cbf772dfb5bcfd020c42c2470d0287c4b780a8 (patch)
treed527df1a25fee996c213dc453d1e0afaac36b246 /shared-bindings
parentd79f4e26621681d80e72a614ca8f2210ac4ca02f (diff)
canio.CAN: clarify read-only status of several properties
Diffstat (limited to 'shared-bindings')
-rw-r--r--shared-bindings/canio/CAN.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/shared-bindings/canio/CAN.c b/shared-bindings/canio/CAN.c
index e8ab15a3c..6dae36943 100644
--- a/shared-bindings/canio/CAN.c
+++ b/shared-bindings/canio/CAN.c
@@ -172,7 +172,7 @@ STATIC const mp_obj_property_t canio_can_receive_error_count_obj = {
};
//| state: State
-//| """The current state of the bus."""
+//| """The current state of the bus. (read-only)"""
STATIC mp_obj_t canio_can_state_get(mp_obj_t self_in) {
canio_can_obj_t *self = MP_OBJ_TO_PTR(self_in);
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
MP_DEFINE_CONST_FUN_OBJ_KW(canio_can_listen_obj, 1, canio_can_listen);
//| loopback: bool
-//| """True if the device was created in loopback mode, False otherwise"""
+//| """True if the device was created in loopback mode, False
+//| otherwise (read-only)"""
//|
STATIC mp_obj_t canio_can_loopback_get(mp_obj_t self_in) {
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) {
MP_DEFINE_CONST_FUN_OBJ_2(canio_can_send_obj, canio_can_send);
//| silent: bool
-//| """True if the device was created in silent mode, False otherwise"""
+//| """True if the device was created in silent mode, False
+//| otherwise (read-only)"""
//|
STATIC mp_obj_t canio_can_silent_get(mp_obj_t self_in) {
canio_can_obj_t *self = MP_OBJ_TO_PTR(self_in);