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:
Laurens Valk
2021-07-14 15:36:18 +02:00
parent 97e368312e
commit cd7d5be748
+3 -4
View File
@@ -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.
"""