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

Documentation fixes for pydoctor.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wokkel/pubsub.py

    r165 r166  
    169169        """
    170170        @param id: optional item identifier
    171         @type id: L{unicode}
     171        @type id: C{unicode}
    172172        @param payload: optional item payload. Either as a domish element, or
    173173                        as serialized XML.
    174         @type payload: object providing L{domish.IElement} or L{unicode}.
     174        @type payload: object providing L{domish.IElement} or C{unicode}.
    175175        """
    176176
     
    194194    C{None}.
    195195
    196     @ivar verb: The type of publish-subscribe request. See L{_requestVerbMap}.
     196    @ivar verb: The type of publish-subscribe request. See C{_requestVerbMap}.
    197197    @type verb: C{str}.
    198198
    199199    @ivar affiliations: Affiliations to be modified.
    200200    @type affiliations: C{set}
     201
    201202    @ivar items: The items to be published, as L{domish.Element}s.
    202203    @type items: C{list}
     204
    203205    @ivar itemIdentifiers: Identifiers of the items to be retrieved or
    204206                           retracted.
    205207    @type itemIdentifiers: C{set}
     208
    206209    @ivar maxItems: Maximum number of items to retrieve.
    207210    @type maxItems: C{int}.
     211
    208212    @ivar nodeIdentifier: Identifier of the node the request is about.
    209213    @type nodeIdentifier: C{unicode}
     214
    210215    @ivar nodeType: The type of node that should be created, or for which the
    211216                    configuration is retrieved. C{'leaf'} or C{'collection'}.
    212217    @type nodeType: C{str}
     218
    213219    @ivar options: Configurations options for nodes, subscriptions and publish
    214220                   requests.
    215221    @type options: L{data_form.Form}
     222
    216223    @ivar subscriber: The subscribing entity.
    217     @type subscriber: L{JID}
     224    @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
     225
    218226    @ivar subscriptionIdentifier: Identifier for a specific subscription.
    219227    @type subscriptionIdentifier: C{unicode}
     228
    220229    @ivar subscriptions: Subscriptions to be modified, as a set of
    221                          L{Subscription}.
     230        L{Subscription}.
    222231    @type subscriptions: C{set}
     232
    223233    @ivar affiliations: Affiliations to be modified, as a dictionary of entity
    224                         (L{JID} to affiliation (C{unicode}).
     234        (L{JID<twisted.words.protocols.jabber.jid.JID>} to affiliation
     235        (C{unicode}).
    225236    @type affiliations: C{dict}
    226237    """
     
    599610
    600611        @param xs: The XML stream to send the request on.
    601         @type xs: L{xmlstream.XmlStream}
     612        @type xs: L{twisted.words.protocols.jabber.xmlstream.XmlStream}
    602613        @rtype: L{defer.Deferred}.
    603614        """
     
    637648    @type nodeIdentifier: C{unicode}
    638649    @param headers: SHIM headers, see L{wokkel.shim.extractHeaders}.
    639     @type headers: L{dict}
     650    @type headers: C{dict}
    640651    """
    641652
     
    758769
    759770        @param service: The publish subscribe service to create the node at.
    760         @type service: L{JID}
     771        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    761772        @param nodeIdentifier: Optional suggestion for the id of the node.
    762773        @type nodeIdentifier: C{unicode}
     
    793804
    794805        @param service: The publish subscribe service to delete the node from.
    795         @type service: L{JID}
     806        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    796807        @param nodeIdentifier: The identifier of the node.
    797808        @type nodeIdentifier: C{unicode}
     
    810821
    811822        @param service: The publish subscribe service that keeps the node.
    812         @type service: L{JID}
     823        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    813824
    814825        @param nodeIdentifier: The identifier of the node.
     
    817828        @param subscriber: The entity to subscribe to the node. This entity
    818829            will get notifications of new published items.
    819         @type subscriber: L{JID}
     830        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
    820831
    821832        @param options: Subscription options.
     
    862873
    863874        @param service: The publish subscribe service that keeps the node.
    864         @type service: L{JID}
     875        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    865876
    866877        @param nodeIdentifier: The identifier of the node.
     
    868879
    869880        @param subscriber: The entity to unsubscribe from the node.
    870         @type subscriber: L{JID}
     881        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
    871882
    872883        @param subscriptionIdentifier: Optional subscription identifier.
     
    887898
    888899        @param service: The publish subscribe service that keeps the node.
    889         @type service: L{JID}
     900        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    890901        @param nodeIdentifier: The identifier of the node.
    891902        @type nodeIdentifier: C{unicode}
     
    907918
    908919        @param service: The publish subscribe service that keeps the node.
    909         @type service: L{JID}
     920        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    910921
    911922        @param nodeIdentifier: The identifier of the node.
     
    946957
    947958        @param service: The publish subscribe service that keeps the node.
    948         @type service: L{JID}
     959        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    949960
    950961        @param nodeIdentifier: The identifier of the node.
     
    952963
    953964        @param subscriber: The entity subscribed to the node.
    954         @type subscriber: L{JID}
     965        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
    955966
    956967        @param subscriptionIdentifier: Optional subscription identifier.
     
    983994
    984995        @param service: The publish subscribe service that keeps the node.
    985         @type service: L{JID}
     996        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    986997
    987998        @param nodeIdentifier: The identifier of the node.
     
    9891000
    9901001        @param subscriber: The entity subscribed to the node.
    991         @type subscriber: L{JID}
     1002        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
    9921003
    9931004        @param options: Subscription options.
     
    10221033    subscriptions, and sending out notifications.
    10231034
    1024     Methods from the L{IPubSubService} interface that are called as
    1025     a result of an XMPP request may raise exceptions. Alternatively the
    1026     deferred returned by these methods may have their errback called. These are
    1027     handled as follows:
     1035    Methods from the L{IPubSubService} interface that are called as a result
     1036    of an XMPP request may raise exceptions. Alternatively the deferred
     1037    returned by these methods may have their errback called. These are handled
     1038    as follows:
    10281039
    10291040     - If the exception is an instance of L{error.StanzaError}, an error
Note: See TracChangeset for help on using the changeset viewer.