Ignore:
Timestamp:
Jan 23, 2012, 3:48:48 PM (9 years ago)
Author:
Ralph Meijer <ralphm@…>
Branch:
default
Message:

Documentation fixes for pydoctor.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wokkel/subprotocols.py

    r165 r166  
    131131    @type xmlstream: L{XmlStream}
    132132    @ivar logTraffic: if true, log all traffic.
    133     @type logTraffic: L{bool}
     133    @type logTraffic: C{bool}
    134134    @ivar _initialized: Whether the stream represented by L{xmlstream} has
    135135                        been initialized. This is used when caching outgoing
     
    320320
    321321        A request is an IQ L{generic.Stanza} of type C{'get'} or C{'set'}. It
    322         will have its C{toElement} called to render to a L{domish.Element}
    323         which is then sent out over the current stream. If there is no such
    324         stream (yet), it is queued and sent whenever a connection is
    325         established and initialized, just like L{send}.
     322        will have its C{toElement} called to render to a
     323        L{Element<twisted.words.xish.domish.Element>} which is then sent out
     324        over the current stream. If there is no such stream (yet), it is queued
     325        and sent whenever a connection is established and initialized, just
     326        like L{send}.
    326327
    327328        If the request doesn't have an identifier, it will be assigned a fresh
    328329        one, so the response can be tracked.
    329330
    330         The deferred that is returned will fire with the L{domish.Element}
    331         representation of the response if it is a result iq. If the response
    332         is an error iq, a corresponding L{error.StanzaError} will be errbacked.
     331        The deferred that is returned will fire with the
     332        L{Element<twisted.words.xish.domish.Element>} representation of the
     333        response if it is a result iq. If the response is an error iq, a
     334        corresponding L{error.StanzaError} will be errbacked.
    333335
    334336        If the connection is closed before a response was received, the deferred
     
    336338
    337339        A request may also have a timeout, either by setting a default timeout
    338         in L{StreamManager.timeout} or on the C{timeout} attribute of the
    339         request.
     340        in L{StreamManager}'s C{timeout} attribute or on the C{timeout}
     341        attribute of the request.
    340342
    341343        @param request: The IQ request.
     
    419421    @cvar iqHandlers: Mapping from XPath queries (as a string) to the method
    420422                      name that will handle requests that match the query.
    421     @type iqHandlers: L{dict}
     423    @type iqHandlers: C{dict}
    422424    """
    423425
Note: See TracChangeset for help on using the changeset viewer.