From 3bc9b571bb5e8ffdcdb3ce1e8b20c1fb90520c5b Mon Sep 17 00:00:00 2001 From: Paul Sokolovsky Date: Fri, 22 Apr 2016 22:35:31 +0300 Subject: docs/ustruct: There's no complete "struct" module, only "ustruct" subset. "ustruct" is good example of micro-ified module, so rather should belong to the corresponding list. --- docs/library/index.rst | 5 ++--- docs/library/struct.rst | 25 ------------------------- docs/library/ustruct.rst | 25 +++++++++++++++++++++++++ 3 files changed, 27 insertions(+), 28 deletions(-) delete mode 100644 docs/library/struct.rst create mode 100644 docs/library/ustruct.rst (limited to 'docs') diff --git a/docs/library/index.rst b/docs/library/index.rst index 47cd2eeb8..5ae1ed86f 100644 --- a/docs/library/index.rst +++ b/docs/library/index.rst @@ -26,7 +26,6 @@ For additional libraries, please download them from the `micropython-lib reposit gc.rst math.rst os.rst - struct.rst sys.rst time.rst @@ -40,7 +39,6 @@ For additional libraries, please download them from the `micropython-lib reposit math.rst os.rst select.rst - struct.rst sys.rst time.rst @@ -62,7 +60,6 @@ For additional libraries, please download them from the `micropython-lib reposit gc.rst math.rst - struct.rst sys.rst time.rst @@ -94,6 +91,7 @@ library. ujson.rst ure.rst usocket.rst + ustruct.rst uzlib.rst .. only:: port_esp8266 @@ -107,6 +105,7 @@ library. uheapq.rst ujson.rst ure.rst + ustruct.rst uzlib.rst .. only:: port_pyboard diff --git a/docs/library/struct.rst b/docs/library/struct.rst deleted file mode 100644 index 71ee5c9b7..000000000 --- a/docs/library/struct.rst +++ /dev/null @@ -1,25 +0,0 @@ -:mod:`struct` -- pack and unpack primitive data types -===================================================== - -.. module:: struct - :synopsis: pack and unpack primitive data types - -See `Python struct `_ for more -information. - -Functions ---------- - -.. function:: calcsize(fmt) - - Return the number of bytes needed to store the given ``fmt``. - -.. function:: pack(fmt, v1, v2, ...) - - Pack the values ``v1``, ``v2``, ... according to the format string ``fmt``. - The return value is a bytes object encoding the values. - -.. function:: unpack(fmt, data) - - Unpack from the ``data`` according to the format string ``fmt``. - The return value is a tuple of the unpacked values. diff --git a/docs/library/ustruct.rst b/docs/library/ustruct.rst new file mode 100644 index 000000000..f65d6058d --- /dev/null +++ b/docs/library/ustruct.rst @@ -0,0 +1,25 @@ +:mod:`ustruct` -- pack and unpack primitive data types +====================================================== + +.. module:: ustruct + :synopsis: pack and unpack primitive data types + +See `Python struct `_ for more +information. + +Functions +--------- + +.. function:: calcsize(fmt) + + Return the number of bytes needed to store the given ``fmt``. + +.. function:: pack(fmt, v1, v2, ...) + + Pack the values ``v1``, ``v2``, ... according to the format string ``fmt``. + The return value is a bytes object encoding the values. + +.. function:: unpack(fmt, data) + + Unpack from the ``data`` according to the format string ``fmt``. + The return value is a tuple of the unpacked values. -- cgit v1.2.3