summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2015-06-06 22:57:31 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2015-06-06 22:58:04 +0300
commit06e85ecfa6970ff71b6c9c92648a148c34fea002 (patch)
tree5273d85bd9b99f8560492ea1bb846583b059c879
parent1679696612007107dac55d936006b1923eda2475 (diff)
downloadmicropython-06e85ecfa6970ff71b6c9c92648a148c34fea002.tar.gz
micropython-06e85ecfa6970ff71b6c9c92648a148c34fea002.zip
docs/uctype: Update for constructor argument order changes.
Also, other small cleanups/improvements.
-rw-r--r--docs/library/uctypes.rst13
1 files 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)