diff options
| author | INADA Naoki <inada-n@klab.com> | 2013-02-26 14:23:08 +0900 |
|---|---|---|
| committer | INADA Naoki <inada-n@klab.com> | 2013-02-26 14:23:08 +0900 |
| commit | b588e8cec6f5055351fb663bfddcf7a2a4aa9f9a (patch) | |
| tree | da3f0becce56dc409c076e9cf80d70e9cd94e6c1 /docs/api.rst | |
| parent | f1dcf4ef55a375c3cd1cd5d6aea4ad62b68be4cd (diff) | |
| parent | d2feb1362946c87609e3753a058ddbd0958ee0bd (diff) | |
| download | msgpack-python-next-marker.tar.gz | |
Merge branch 'master' into next-markernext-marker
Conflicts:
msgpack/fallback.py
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..50a84c4 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,37 @@ +API reference +============= + +.. module:: msgpack + +.. autofunction:: pack + +:func:`dump` is alias for :func:`pack` + +.. autofunction:: packb + +:func:`dumps` is alias for :func:`packb` + +.. autofunction:: unpack + +:func:`load` is alias for :func:`unpack` + +.. autofunction:: unpackb + +:func:`loads` is alias for :func:`unpackb` + +.. autoclass:: Packer + :members: + +.. autoclass:: Unpacker + :members: + +exceptions +----------- + +These exceptions are accessible via `msgpack` package. +(For example, `msgpack.OutOfData` is shortcut for `msgpack.exceptions.OutOfData`) + +.. automodule:: msgpack.exceptions + :members: + :undoc-members: + :show-inheritance: |