mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-07-28 04:07:46 +00:00
micropython.stack_info: Clean up docstring.
Reword to say how it useful, not how it is not useful. Also fix return type.
This commit is contained in:
@@ -101,11 +101,10 @@ def qstr_info(*args):
|
||||
"""
|
||||
|
||||
|
||||
def stack_use() -> None:
|
||||
def stack_use() -> int:
|
||||
"""
|
||||
Return an integer representing the current amount of stack that is being
|
||||
used. The absolute value of this is not particularly useful, rather it
|
||||
should be used to compute differences in stack usage at different points.
|
||||
Returns the amount of stack that is being used. This can be used to
|
||||
compute differences in stack usage at different points in a script.
|
||||
"""
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user