diff options
| author | Daniel Campora <daniel@wipy.io> | 2015-06-10 23:29:56 +0200 |
|---|---|---|
| committer | Daniel Campora <daniel@wipy.io> | 2015-06-10 23:37:56 +0200 |
| commit | cfcf47c0644952358e1a260db159e807872a37e6 (patch) | |
| tree | 02522a025a7b803d7de0589dd743b34f3daa4634 /docs/library/micropython.rst | |
| parent | b630de1103cd07ac0656c76c7f90d92312705835 (diff) | |
docs: Add initial draft documentation for the WiPy.
This makes all common files "port-aware" using the .. only directive.
Diffstat (limited to 'docs/library/micropython.rst')
| -rw-r--r-- | docs/library/micropython.rst | 36 |
1 files changed, 19 insertions, 17 deletions
diff --git a/docs/library/micropython.rst b/docs/library/micropython.rst index 83ccb2900..14e4c917e 100644 --- a/docs/library/micropython.rst +++ b/docs/library/micropython.rst @@ -7,23 +7,25 @@ Functions --------- -.. 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. +.. only:: port_pyboard or port_unix + + .. 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) |