Rooba
/
boltons
mirror of https://github.com/mahmoud/boltons.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix a few :type:-os (sphinx wants :class:, not :type:)

This commit is contained in:
Mahmoud Hashemi 2016-05-23 10:10:49 -07:00
parent e86b2ccf21
commit 245d8962ef
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
boltons/socketutils.py
View File

@ -575,7 +575,7 @@ class Error(socket.error):
class ConnectionClosed(Error): class ConnectionClosed(Error):
"""Raised when receiving and the connection is unexpectedly closed """Raised when receiving and the connection is unexpectedly closed
from the sending end. Raised from :type:`BufferedSocket`'s from the sending end. Raised from :class:`BufferedSocket`'s
:meth:`~BufferedSocket.peek`, :meth:`~BufferedSocket.recv_until`, :meth:`~BufferedSocket.peek`, :meth:`~BufferedSocket.recv_until`,
and :meth:`~BufferedSocket.recv_size`, and never from its and :meth:`~BufferedSocket.recv_size`, and never from its
:meth:`~BufferedSocket.recv` or :meth:`~BufferedSocket.recv` or
@ -602,7 +602,7 @@ class MessageTooLong(Error):
class Timeout(socket.timeout, Error): class Timeout(socket.timeout, Error):
"""Inheriting from :exc:`socket.timeout`, Timeout is used to indicate """Inheriting from :exc:`socket.timeout`, Timeout is used to indicate
when a socket operation did not complete within the time when a socket operation did not complete within the time
specified. Raised from any of :type:`BufferedSocket`'s ``recv`` specified. Raised from any of :class:`BufferedSocket`'s ``recv``
methods. methods.
""" """
def __init__(self, timeout, extra=""): def __init__(self, timeout, extra=""):
@ -680,7 +680,7 @@ class NetstringInvalidSize(NetstringProtocolError):
5:hello, 5:hello,
Here the ``5`` is the size. Anything in this prefix position that Here the ``5`` is the size. Anything in this prefix position that
is not parsable as a Python integer (i.e., :type:`int`) will raise is not parsable as a Python integer (i.e., :class:`int`) will raise
this exception. this exception.
""" """
def __init__(self, msg): def __init__(self, msg):
@ -690,7 +690,7 @@ class NetstringInvalidSize(NetstringProtocolError):
class NetstringMessageTooLong(NetstringProtocolError): class NetstringMessageTooLong(NetstringProtocolError):
"""NetstringMessageTooLong is raised when the size prefix contains a """NetstringMessageTooLong is raised when the size prefix contains a
valid integer, but that integer is larger than the valid integer, but that integer is larger than the
:type:`NetstringSocket`'s configured *maxsize*. :class:`NetstringSocket`'s configured *maxsize*.
When this exception is raised, it's recommended to simply close When this exception is raised, it's recommended to simply close
the connection instead of trying to recover. the connection instead of trying to recover.

2
boltons/statsutils.py
View File

@ -468,7 +468,7 @@ class Stats(object):
quartiles. quartiles.
format (str): Controls the return type of the function, format (str): Controls the return type of the function,
with one of three valid values: ``"dict"`` gives back with one of three valid values: ``"dict"`` gives back
a :type:`dict` with the appropriate keys and a :class:`dict` with the appropriate keys and
values. ``"list"`` is a list of key-value pairs in an values. ``"list"`` is a list of key-value pairs in an
order suitable to pass to an OrderedDict or HTML order suitable to pass to an OrderedDict or HTML
table. ``"text"`` converts the values to text suitable table. ``"text"`` converts the values to text suitable