Skip to content

Commit 6e8031f

Browse files
authored
Note limitation of next_stack_limit on espressif boards
Open to better wording.
1 parent 5116c01 commit 6e8031f

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

shared-bindings/supervisor/Runtime.c

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,8 +187,10 @@ MP_PROPERTY_GETSET(supervisor_runtime_ble_workflow_obj,
187187
(mp_obj_t)&supervisor_runtime_set_ble_workflow_obj);
188188

189189
//| next_stack_limit: int
190-
//| """The size of the stack for the next vm run. If its too large, the default will be used."""
190+
//| """The size of the stack for the next vm run. If its too large, the default will be used.
191191
//|
192+
//| **Limitations**: Stack size is fixed at startup on ``espressif`` port and this will have no effect.
193+
//| """
192194
STATIC mp_obj_t supervisor_runtime_get_next_stack_limit(mp_obj_t self) {
193195
return mp_obj_new_int(get_next_stack_size());
194196
}

0 commit comments

Comments
 (0)