Skip to content

Commit

Permalink
Minor Sphinx documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
aperezdc committed Nov 27, 2015
1 parent 982d2df commit aad4bc4
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/apiref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ API Reference
:mod:`hipack`
=============

.. automodule:: lasso
.. automodule:: hipack
:members:
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath(os.path.dirname(os.path.dirname(__file__))))

# -- General configuration ------------------------------------------------

Expand Down
6 changes: 3 additions & 3 deletions hipack.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Distributed under terms of the GPL3 license or, if that suits you
# better the MIT/X11 license.

"""This module provide a pythonic way to parse HiPack messages.
"""This module provide a pythonic way to handle HiPack messages.
"""

__version__ = 9
Expand Down Expand Up @@ -562,7 +562,7 @@ def load(stream, cast=cast):
:param stream:
A file-like object with a `.read(n)` method.
:param callable cast:
A value conversion function, see :cls:`Parser` for details.
A value conversion function, see :class:`Parser` for details.
"""
return Parser(stream, cast).parse_message()

Expand All @@ -575,7 +575,7 @@ def loads(bytestring, cast=cast):
Input string. It is valid to pass any of `str`, `unicode`, and `bytes`
objects as input.
:param callable cast:
A value conversion function, see :cls:`Parser` for details.
A value conversion function, see :class:`Parser` for details.
"""
if isinstance(bytestring, six.text_type):
bytestring = bytestring.encode("utf-8")
Expand Down

0 comments on commit aad4bc4

Please sign in to comment.