Changeset 166:d9c10a5b5c0d for wokkel/subprotocols.py

Timestamp:

Jan 23, 2012, 3:48:48 PM (10 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Documentation fixes for pydoctor.

File:

• wokkel/subprotocols.py (modified) (4 diffs)

wokkel/subprotocols.py

@@ -131 +131 @@
     @type xmlstream: L{XmlStream}
     @ivar logTraffic: if true, log all traffic.
-    @type logTraffic: L{bool}
+    @type logTraffic: C{bool}
     @ivar _initialized: Whether the stream represented by L{xmlstream} has
                         been initialized. This is used when caching outgoing
@@ -320 +320 @@
 
         A request is an IQ L{generic.Stanza} of type C{'get'} or C{'set'}. It
-        will have its C{toElement} called to render to a L{domish.Element}
-        which is then sent out over the current stream. If there is no such
-        stream (yet), it is queued and sent whenever a connection is
-        established and initialized, just like L{send}.
+        will have its C{toElement} called to render to a
+        L{Element<twisted.words.xish.domish.Element>} which is then sent out
+        over the current stream. If there is no such stream (yet), it is queued
+        and sent whenever a connection is established and initialized, just
+        like L{send}.
 
         If the request doesn't have an identifier, it will be assigned a fresh
         one, so the response can be tracked.
 
-        The deferred that is returned will fire with the L{domish.Element}
-        representation of the response if it is a result iq. If the response
-        is an error iq, a corresponding L{error.StanzaError} will be errbacked.
+        The deferred that is returned will fire with the
+        L{Element<twisted.words.xish.domish.Element>} representation of the
+        response if it is a result iq. If the response is an error iq, a
+        corresponding L{error.StanzaError} will be errbacked.
 
         If the connection is closed before a response was received, the deferred
@@ -336 +338 @@
 
         A request may also have a timeout, either by setting a default timeout
-        in L{StreamManager.timeout} or on the C{timeout} attribute of the
-        request.
+        in L{StreamManager}'s C{timeout} attribute or on the C{timeout}
+        attribute of the request.
 
         @param request: The IQ request.
@@ -419 +421 @@
     @cvar iqHandlers: Mapping from XPath queries (as a string) to the method
                       name that will handle requests that match the query.
-    @type iqHandlers: L{dict}
+    @type iqHandlers: C{dict}
     """