don't use @property in docs, just document as a property

This commit is contained in:
Neradoc 2022-09-25 07:18:18 +02:00
parent 2dbcd760fc
commit 5346b89b08
2 changed files with 10 additions and 16 deletions

View File

@ -521,9 +521,8 @@ STATIC mp_obj_t rp2pio_statemachine_obj_stop_background_write(mp_obj_t self_in)
}
MP_DEFINE_CONST_FUN_OBJ_1(rp2pio_statemachine_stop_background_write_obj, rp2pio_statemachine_obj_stop_background_write);
//| @property
//| def writing(self) -> bool:
//| """Returns True if a background write is in progress"""
//| writing: bool
//| """Returns True if a background write is in progress"""
//|
STATIC mp_obj_t rp2pio_statemachine_obj_get_writing(mp_obj_t self_in) {
rp2pio_statemachine_obj_t *self = MP_OBJ_TO_PTR(self_in);
@ -539,11 +538,10 @@ const mp_obj_property_t rp2pio_statemachine_writing_obj = {
};
//| @property
//| def pending(self) -> int:
//| """Returns the number of pending buffers for background writing.
//| pending: int
//| """Returns the number of pending buffers for background writing.
//|
//| If the number is 0, then a `StateMachine.background_write` call will not block."""
//| If the number is 0, then a `StateMachine.background_write` call will not block."""
//|
STATIC mp_obj_t rp2pio_statemachine_obj_get_pending(mp_obj_t self_in) {
rp2pio_statemachine_obj_t *self = MP_OBJ_TO_PTR(self_in);

View File

@ -201,11 +201,9 @@ STATIC mp_obj_t sdioio_sdcard_writeblocks(mp_obj_t self_in, mp_obj_t start_block
MP_DEFINE_CONST_FUN_OBJ_3(sdioio_sdcard_writeblocks_obj, sdioio_sdcard_writeblocks);
//| @property
//| def frequency(self) -> int:
//| """The actual SDIO bus frequency. This may not match the frequency
//| requested due to internal limitations."""
//| ...
//| frequency: int
//| """The actual SDIO bus frequency. This may not match the frequency
//| requested due to internal limitations."""
//|
STATIC mp_obj_t sdioio_sdcard_obj_get_frequency(mp_obj_t self_in) {
sdioio_sdcard_obj_t *self = MP_OBJ_TO_PTR(self_in);
@ -217,10 +215,8 @@ MP_DEFINE_CONST_FUN_OBJ_1(sdioio_sdcard_get_frequency_obj, sdioio_sdcard_obj_get
MP_PROPERTY_GETTER(sdioio_sdcard_frequency_obj,
(mp_obj_t)&sdioio_sdcard_get_frequency_obj);
//| @property
//| def width(self) -> int:
//| """The actual SDIO bus width, in bits"""
//| ...
//| width:int
//| """The actual SDIO bus width, in bits"""
//|
STATIC mp_obj_t sdioio_sdcard_obj_get_width(mp_obj_t self_in) {
sdioio_sdcard_obj_t *self = MP_OBJ_TO_PTR(self_in);