summaryrefslogtreecommitdiff
path: root/shared-bindings/msgpack
diff options
context:
space:
mode:
authorScott Shawcroft <scott@tannewt.org>2021-01-06 09:03:58 -0800
committerScott Shawcroft <scott@tannewt.org>2021-01-06 09:03:58 -0800
commitcdad59fbc2d681d06a21aefedb00a6b6946cce1c (patch)
treec69d54e2c0c32797b892bcf0d596decdfd141145 /shared-bindings/msgpack
parent1a82555803ab66bdb608508fccbcc9acc9bac657 (diff)
Fix doc build with extra blank lines
Diffstat (limited to 'shared-bindings/msgpack')
-rw-r--r--shared-bindings/msgpack/__init__.c9
1 files changed, 7 insertions, 2 deletions
diff --git a/shared-bindings/msgpack/__init__.c b/shared-bindings/msgpack/__init__.c
index e1b6b8fce..f5c47bb21 100644
--- a/shared-bindings/msgpack/__init__.c
+++ b/shared-bindings/msgpack/__init__.c
@@ -41,7 +41,8 @@
//|
//| Not implemented: 64-bit int, uint, float.
//|
-//| Example 1:
+//| Example 1::
+//|
//| import msgpack
//| from io import BytesIO
//|
@@ -50,7 +51,7 @@
//| b.seek(0)
//| print(msgpack.unpack(b))
//|
-//| Example 2: handling objects
+//| Example 2: handling objects::
//|
//| from msgpack import pack, unpack, ExtType
//| from io import BytesIO
@@ -78,11 +79,13 @@
//| buffer.seek(0)
//| decoded = unpack(buffer, ext_hook=decoder)
//| print(f"{data} -> {buffer.getvalue()} -> {decoded}")
+//|
//| """
//|
//| def pack(obj: object, buffer: WriteableBuffer, *, default: Union[Callable[[object], None], None] = None) -> None:
//| """Ouput object to buffer in msgpack format.
+//|
//| :param object obj: Object to convert to msgpack format.
//| :param ~_typing.WriteableBuffer buffer: buffer to write into
//| :param Optional[~_typing.Callable[[object], None]] default:
@@ -114,10 +117,12 @@ MP_DEFINE_CONST_FUN_OBJ_KW(mod_msgpack_pack_obj, 1, mod_msgpack_pack);
//| def unpack(buffer: ReadableBuffer, *, ext_hook: Union[Callable[[int, bytes], object], None] = None, use_list: bool=True) -> object:
//| """Unpack and return one object from buffer.
+//|
//| :param ~_typing.ReadableBuffer buffer: buffer to read from
//| :param Optional[~_typing.Callable[[int, bytes], object]] ext_hook: function called for objects in
//| msgpack ext format.
//| :param Optional[bool] use_list: return array as list or tuple (use_list=False).
+//|
//| :return object: object read from buffer.
//| """
//| ...