diff options
| author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2016-05-01 13:34:16 +0300 |
|---|---|---|
| committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2016-05-01 13:34:16 +0300 |
| commit | c468fe65c52d17c8a11ba75156867fa628c66dca (patch) | |
| tree | 11e577d3a5374ab83b04ce46a7b836fb1a142d54 | |
| parent | a9ed42b3b415d49978ac90e133d23c4ab26b5241 (diff) | |
| download | micropython-c468fe65c52d17c8a11ba75156867fa628c66dca.tar.gz micropython-c468fe65c52d17c8a11ba75156867fa628c66dca.zip | |
docs/ustruct: Fix argument formatting.
Per current CPython docs conventions, arguments are in italics. Follow
that.
| -rw-r--r-- | docs/library/ustruct.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/library/ustruct.rst b/docs/library/ustruct.rst index cebf0b8ef2..ae5b1be003 100644 --- a/docs/library/ustruct.rst +++ b/docs/library/ustruct.rst @@ -12,11 +12,11 @@ Functions .. 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, ...) - 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. .. function:: pack_into(fmt, buffer, offset, v1, v2, ...) @@ -27,7 +27,7 @@ Functions .. 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. .. function:: unpack_from(fmt, data, offset=0) |