diff options
| author | Jason Neal | 2020-01-11 19:44:17 +1300 |
|---|---|---|
| committer | Damien George | 2020-01-12 13:44:59 +1100 |
| commit | 7ef2f65114f092be6303c145a2560fdf522dcde0 (patch) | |
| tree | 52ea36a8dc03bc5e6a4b0b4b332a5c8d784d8a39 /docs/library/uctypes.rst | |
| parent | 6632dd3981cbdca8e70c0bf19e36338101e9ce0e (diff) | |
docs/library: Add / to indicate positional-only args in library docs.
Removes the confusion of positional-only arguments which have defaults that
look like keyword arguments.
Diffstat (limited to 'docs/library/uctypes.rst')
| -rw-r--r-- | docs/library/uctypes.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/library/uctypes.rst b/docs/library/uctypes.rst index dce8caecb..0fdc40e48 100644 --- a/docs/library/uctypes.rst +++ b/docs/library/uctypes.rst @@ -180,7 +180,7 @@ Following are encoding examples for various field types: Module contents --------------- -.. class:: struct(addr, descriptor, layout_type=NATIVE) +.. class:: struct(addr, descriptor, layout_type=NATIVE, /) Instantiate a "foreign data structure" object based on structure address in memory, descriptor (encoded as a dictionary), and layout type (see below). @@ -200,7 +200,7 @@ Module contents Layout type for a native structure - with data endianness and alignment conforming to the ABI of the system on which MicroPython runs. -.. function:: sizeof(struct, layout_type=NATIVE) +.. function:: sizeof(struct, layout_type=NATIVE, /) Return size of data structure in bytes. The *struct* argument can be either a structure class or a specific instantiated structure object |