TonBERRY/micropython
3
0
Fork 0
Code Pull Requests Activity

docs: Add initial draft documentation for the WiPy.

Browse Source 
This makes all common files "port-aware" using the .. only directive.
This commit is contained in:
Daniel Campora
2015-06-10 23:29:56 +02:00
parent b630de1103
commit cfcf47c064
33 changed files with 2155 additions and 835 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/library/micropython.rst
View File

@@ -7,23 +7,25 @@
Functions
---------
.. function:: mem_info([verbose])
.. only:: port_pyboard or port_unix
Print information about currently used memory. If the ``verbose`` argument
is given then extra information is printed.
The information that is printed is implementation dependent, but currently
includes the amount of stack and heap used. In verbose mode it prints out
the entire heap indicating which blocks are used and which are free.
.. function:: qstr_info([verbose])
Print information about currently interned strings. If the ``verbose``
argument is given then extra information is printed.
The information that is printed is implementation dependent, but currently
includes the number of interned strings and the amount of RAM they use. In
verbose mode it prints out the names of all RAM-interned strings.
.. function:: mem_info([verbose])
Print information about currently used memory. If the ``verbose`` argument
is given then extra information is printed.
The information that is printed is implementation dependent, but currently
includes the amount of stack and heap used. In verbose mode it prints out
the entire heap indicating which blocks are used and which are free.
.. function:: qstr_info([verbose])
Print information about currently interned strings. If the ``verbose``
argument is given then extra information is printed.
The information that is printed is implementation dependent, but currently
includes the number of interned strings and the amount of RAM they use. In
verbose mode it prints out the names of all RAM-interned strings.
.. function:: alloc_emergency_exception_buf(size)