From 06e85ecfa6970ff71b6c9c92648a148c34fea002 Mon Sep 17 00:00:00 2001 From: Paul Sokolovsky Date: Sat, 6 Jun 2015 22:57:31 +0300 Subject: [PATCH] docs/uctype: Update for constructor argument order changes. Also, other small cleanups/improvements. --- docs/library/uctypes.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/library/uctypes.rst b/docs/library/uctypes.rst index c124592b3c..9a1a0d234c 100644 --- a/docs/library/uctypes.rst +++ b/docs/library/uctypes.rst @@ -96,16 +96,15 @@ Following are encoding examples for various field types: Module contents --------------- -.. class:: struct(descriptor, addr, layout_type=NATIVE) +.. class:: struct(addr, descriptor, layout_type=NATIVE) - Instantiate a "foreign data structure" object based on structure descriptor - (encoded as a dictionary), layout type (see below), and actual structure - address. + Instantiate a "foreign data structure" object based on structure address in + memory, descriptor (encoded as a dictionary), and layout type (see below). .. data:: LITTLE_ENDIAN Little-endian packed structure. (Packed means that every field occupies - exactly many bytes as defined in the descriptor, i.e. alignment is 1). + exactly as many bytes as defined in the descriptor, i.e. alignment is 1). .. data:: BIG_ENDIAN @@ -114,12 +113,12 @@ Module contents .. data:: NATIVE Native structure - with data endianness and alignment conforming to - the target ABI. + the ABI of the system on which MicroPython runs. .. function:: sizeof(struct) Return size of data structure in bytes. Argument can be either structure - class or specific instantiated structure object (or its field). + class or specific instantiated structure object (or its aggregate field). .. function:: addressof(obj)