msgpack-python/docs/api.rst
TW e3fea94509 fix typos and other cosmetic issues (#214)
cosmetic issues:
- reST headlines' underline length needs to match the headline length
  (looks like somebody is / was using a proportional font)
- Cython code lines do not need to be terminated with a semicolon
- always use triple-double-quotes for docstrings
2017-01-11 12:04:23 +09:00

39 lines
673 B
ReStructuredText

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:
.. autoclass:: ExtType
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: