diff options
| author | Damien George <damien.p.george@gmail.com> | 2014-10-31 01:37:19 +0000 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2014-10-31 01:37:19 +0000 |
| commit | 88d3054ac072f9c73b0f3f045c59ba74f6730c1d (patch) | |
| tree | 6db7851068908c0640b1ed306d6823871fd3d742 /docs/library/sys.rst | |
| parent | 7c4445afe104631d5fe8e7401d50f40f205e35b9 (diff) | |
docs: Import documentation from source-code inline comments.
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
Diffstat (limited to 'docs/library/sys.rst')
| -rw-r--r-- | docs/library/sys.rst | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/library/sys.rst b/docs/library/sys.rst new file mode 100644 index 000000000..b46be4d0d --- /dev/null +++ b/docs/library/sys.rst @@ -0,0 +1,55 @@ +:mod:`sys` --- system specific functions +======================================== + +.. module:: sys + :synopsis: system specific functions + + + +Functions +--------- + +.. function:: exit([retval]) + + Raise a ``SystemExit`` exception. If an argument is given, it is the + value given to ``SystemExit``. + + +Constants +--------- + +.. data:: argv + + a mutable list of arguments this program started with + +.. data:: byteorder + + the byte order of the system ("little" or "big") + +.. data:: path + + a mutable list of directories to search for imported modules + +.. data:: platform + + the platform that Micro Python is running on + +.. data:: stderr + + standard error (connected to USB VCP, and optional UART object) + +.. data:: stdin + + standard input (connected to USB VCP, and optional UART object) + +.. data:: stdout + + standard output (connected to USB VCP, and optional UART object) + +.. data:: version + + Python language version that this implementation conforms to, as a string + +.. data:: version_info + + Python language version that this implementation conforms to, as a tuple of ints |
