r46792 - python-docstring-mode-style docstring wrapping

glyph-TA+aISz0psMTMxyoc4vAAJOcrHinNvQL0E9HWUfgJXw@public.gmane.org
Newsgroups gmane.comp.python.twisted.commits
Message-ID <[email protected]>
Author: glyph
Date: Sun Feb 14 02:55:05 2016
New Revision: 46792

Modified:
   branches/getaddrinfo-4362-3/twisted/internet/interfaces.py

Log:
python-docstring-mode-style docstring wrapping

Modified: branches/getaddrinfo-4362-3/twisted/internet/interfaces.py
==============================================================================
--- branches/getaddrinfo-4362-3/twisted/internet/interfaces.py	(original)
+++ branches/getaddrinfo-4362-3/twisted/internet/interfaces.py	Sun Feb 14 02:55:05 2016
@@ -69,45 +69,52 @@
         @param name: A hostname to resolve.
         @type name: C{str}
 
-        @param service: A port number or the name of the service for which to find address
-            information.  For example, C{22} or C{"ssh"}.
+        @param service: A port number or the name of the service for which to
+            find address information.  For example, C{22} or C{"ssh"}.
         @type service: C{int} or C{str}
 
-        @param family: If specified, limit results to addresses from this family.  Must be one
-            of the address family constants from the socket module.  For example,
-            L{socket.AF_INET}.
-
-        @param socktype: If specified, limit results to addresses for this socket type.  Must be
-            one of the socket type constants from the socket module.  For example,
-            L{socket.SOCK_STREAM}.
-
-        @param proto: If specified, limit results to addresses for this socket protocol.  Must
-            be one of the protocol constants from the socket module.  For example,
-            L{socket.IPPROTO_TCP}.
+        @param family: If specified, limit results to addresses from this
+            family.  Must be one of the address family constants from the
+            socket module.  For example, L{socket.AF_INET}.
+
+        @param socktype: If specified, limit results to addresses for this
+            socket type.  Must be one of the socket type constants from the
+            socket module.  For example, L{socket.SOCK_STREAM}.
+
+        @param proto: If specified, limit results to addresses for this socket
+            protocol.  Must be one of the protocol constants from the socket
+            module.  For example, L{socket.IPPROTO_TCP}.
 
         @param flags: A bitvector specifying zero or more of the following::
-            - Yea right.  Go read the `getaddrinfo(3)` man page.
 
-        @param timeout: The number of seconds after which to cancel
-            the L{Deferred} returned by this function. Can be a single
-            C{int} or an iterable of C{int} for implementations which
-            support retries, in which case the L{Deferred}
-            cancellation timeout will be the sum of all the C{int}s.
+                - Yea right.  Go read the `getaddrinfo(3)` man page.
+
+        @param timeout: The number of seconds after which to cancel the
+            L{Deferred} returned by this function.  Can be a single C{int} or
+            an iterable of C{int} for implementations which support retries, in
+            which case the L{Deferred} cancellation timeout will be the sum of
+            all the C{int}s.
         @type: timeout: C{int} or an iterable of C{int}
 
-        @raise ValueError: If one of the specified flags is not supported by the
-            implementation.  All flags are optional.
+        @raise ValueError: If one of the specified flags is not supported by
+            the implementation.  All flags are optional.
+
+        @return: A L{Deferred} which will fire when the resolution completes.
+            If resolution is successful, the result will be a list of objects
+            with the following attributes:
+
+                - C{family}: the family of this address
+
+                - C{type}: the type of this address
+
+                - C{protocol}: the protocol of this address
 
-        @return: A L{Deferred} which will fire when the resolution completes.  If resolution is
-            successful, the result will be a list of objects with the following attributes:
+                - C{canonicalName}: the canonical name associated with this
+                  address, or an empty string.
 
-            - C{family}: the family of this address
-            - C{type}: the type of this address
-            - C{protocol}: the protocol of this address
-            - C{canonicalName}: the canonical name associated with this address, or an empty
-                                string.
-            - C{address}: The actual address itself, including a port number.  This is suitable
-                          to be passed directly to L{socket.socket.connect}.
+                - C{address}: The actual address itself, including a port
+                  number.  This is suitable to be passed directly to
+                  L{socket.socket.connect}.
         """
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.