djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/ustruct: Fix argument formatting.

Browse Source 
Per current CPython docs conventions, arguments are in italics. Follow
that.
This commit is contained in:
Paul Sokolovsky 2016-05-01 13:34:16 +03:00
parent a9ed42b3b4
commit c468fe65c5
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/library/ustruct.rst
View File

@ -12,11 +12,11 @@ Functions
.. function:: calcsize(fmt) .. function:: calcsize(fmt)
Return the number of bytes needed to store the given ``fmt``. Return the number of bytes needed to store the given `fmt`.
.. function:: pack(fmt, v1, v2, ...) .. function:: pack(fmt, v1, v2, ...)
Pack the values ``v1``, ``v2``, ... according to the format string ``fmt``. Pack the values `v1`, `v2`, ... according to the format string `fmt`.
The return value is a bytes object encoding the values. The return value is a bytes object encoding the values.
.. function:: pack_into(fmt, buffer, offset, v1, v2, ...) .. function:: pack_into(fmt, buffer, offset, v1, v2, ...)
@ -27,7 +27,7 @@ Functions
.. function:: unpack(fmt, data) .. function:: unpack(fmt, data)
Unpack from the ``data`` according to the format string ``fmt``. Unpack from the `data` according to the format string `fmt`.
The return value is a tuple of the unpacked values. The return value is a tuple of the unpacked values.
.. function:: unpack_from(fmt, data, offset=0) .. function:: unpack_from(fmt, data, offset=0)