r47163 - epydoc ref fixes
glyph-TA+aISz0psMTMxyoc4vAAJOcrHinNvQL0E9HWUfgJXw@public.gmane.org Tue, 5 Apr 2016 15:22:02 -0600 (MDT)
| Newsgroups | gmane.comp.python.twisted.commits |
|---|---|
| Message-ID | <[email protected]> |
Author: glyph
Date: Tue Apr 5 15:21:57 2016
New Revision: 47163
Modified:
branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_interfaces.py
branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_v1parser.py
branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_v2parser.py
Log:
epydoc ref fixes
Modified: branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_interfaces.py
==============================================================================
--- branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_interfaces.py (original)
+++ branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_interfaces.py Tue Apr 5 15:21:57 2016
@@ -40,10 +40,9 @@
@param data: A bytestring.
@type data: bytes
- @return: A two-tuple containing, in order, a
- L{twisted.protocols.haproxy.IProxyInfo} and any bytes fed to the
- parser that followed the end of the header. Both of these values
- are None until a complete header is parsed.
+ @return: A two-tuple containing, in order, an L{IProxyInfo} and any
+ bytes fed to the parser that followed the end of the header. Both
+ of these values are None until a complete header is parsed.
@raises InvalidProxyHeader: If the bytes fed to the parser create an
invalid PROXY header.
@@ -58,8 +57,7 @@
protocol header line.
@type line: bytes
- @return: A L{twisted.protocols.haproxy.IProxyInfo} containing the parsed
- data.
+ @return: An L{IProxyInfo} containing the parsed data.
@raises InvalidProxyHeader: If the bytestring does not represent a
valid PROXY header.
Modified: branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_v1parser.py
==============================================================================
--- branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_v1parser.py (original)
+++ branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_v1parser.py Tue Apr 5 15:21:57 2016
@@ -46,11 +46,11 @@
Consume a chunk of data and attempt to parse it.
@param data: A bytestring.
- @type data: bytes
+ @type data: L{bytes}
@return: A two-tuple containing, in order, a
- L{twisted.protocols.haproxy.IProxyInfo} and any bytes fed to the
- parser that followed the end of the header. Both of these values
+ L{_interfaces.IProxyInfo} and any bytes fed to the
+ parser that followed the end of the header. Both of these values
are None until a complete header is parsed.
@raises InvalidProxyHeader: If the bytes fed to the parser create an
@@ -78,8 +78,7 @@
protocol header line.
@type line: bytes
- @return: A L{twisted.protocols.haproxy.IProxyInfo} containing the
- parsed data.
+ @return: A L{_interfaces.IProxyInfo} containing the parsed data.
@raises InvalidProxyHeader: If the bytestring does not represent a
valid PROXY header.
Modified: branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_v2parser.py
==============================================================================
--- branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_v2parser.py (original)
+++ branches/haproxy-endpoint-8203-2/twisted/protocols/haproxy/_v2parser.py Tue Apr 5 15:21:57 2016
@@ -71,10 +71,10 @@
@param data: A bytestring.
@type data: bytes
- @return: A two-tuple containing, in order, a
- L{twisted.protocols.haproxy.IProxyInfo} and any bytes fed to the
- parser that followed the end of the header. Both of these values
- are None until a complete header is parsed.
+ @return: A two-tuple containing, in order, a L{_interfaces.IProxyInfo}
+ and any bytes fed to the parser that followed the end of the
+ header. Both of these values are None until a complete header is
+ parsed.
@raises InvalidProxyHeader: If the bytes fed to the parser create an
invalid PROXY header.
@@ -139,7 +139,7 @@
protocol version 2 header.
@type line: bytes
- @return: A L{twisted.protocols.haproxy.IProxyInfo} containing the
+ @return: A L{_interfaces.IProxyInfo} containing the
parsed data.
@raises InvalidProxyHeader: If the bytestring does not represent a