From 245d8962ef3b8446444ed0988ee190179f917b65 Mon Sep 17 00:00:00 2001 From: Mahmoud Hashemi Date: Mon, 23 May 2016 10:10:49 -0700 Subject: [PATCH] fix a few :type:-os (sphinx wants :class:, not :type:) --- boltons/socketutils.py | 8 ++++---- boltons/statsutils.py | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/boltons/socketutils.py b/boltons/socketutils.py index 459358c..86e7187 100644 --- a/boltons/socketutils.py +++ b/boltons/socketutils.py @@ -575,7 +575,7 @@ class Error(socket.error): class ConnectionClosed(Error): """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`, and :meth:`~BufferedSocket.recv_size`, and never from its :meth:`~BufferedSocket.recv` or @@ -602,7 +602,7 @@ class MessageTooLong(Error): class Timeout(socket.timeout, Error): """Inheriting from :exc:`socket.timeout`, Timeout is used to indicate 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. """ def __init__(self, timeout, extra=""): @@ -680,7 +680,7 @@ class NetstringInvalidSize(NetstringProtocolError): 5:hello, 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. """ def __init__(self, msg): @@ -690,7 +690,7 @@ class NetstringInvalidSize(NetstringProtocolError): class NetstringMessageTooLong(NetstringProtocolError): """NetstringMessageTooLong is raised when the size prefix contains a 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 the connection instead of trying to recover. diff --git a/boltons/statsutils.py b/boltons/statsutils.py index 8d5ebfc..f1be44c 100644 --- a/boltons/statsutils.py +++ b/boltons/statsutils.py @@ -468,7 +468,7 @@ class Stats(object): quartiles. format (str): Controls the return type of the function, 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 order suitable to pass to an OrderedDict or HTML table. ``"text"`` converts the values to text suitable