Changeset 166:d9c10a5b5c0d for wokkel/pubsub.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/pubsub.py (modified) (17 diffs)

wokkel/pubsub.py

@@ -169 +169 @@
         """
         @param id: optional item identifier
-        @type id: L{unicode}
+        @type id: C{unicode}
         @param payload: optional item payload. Either as a domish element, or
                         as serialized XML.
-        @type payload: object providing L{domish.IElement} or L{unicode}.
+        @type payload: object providing L{domish.IElement} or C{unicode}.
         """
 
@@ -194 +194 @@
     C{None}.
 
-    @ivar verb: The type of publish-subscribe request. See L{_requestVerbMap}.
+    @ivar verb: The type of publish-subscribe request. See C{_requestVerbMap}.
     @type verb: C{str}.
 
     @ivar affiliations: Affiliations to be modified.
     @type affiliations: C{set}
+
     @ivar items: The items to be published, as L{domish.Element}s.
     @type items: C{list}
+
     @ivar itemIdentifiers: Identifiers of the items to be retrieved or
                            retracted.
     @type itemIdentifiers: C{set}
+
     @ivar maxItems: Maximum number of items to retrieve.
     @type maxItems: C{int}.
+
     @ivar nodeIdentifier: Identifier of the node the request is about.
     @type nodeIdentifier: C{unicode}
+
     @ivar nodeType: The type of node that should be created, or for which the
                     configuration is retrieved. C{'leaf'} or C{'collection'}.
     @type nodeType: C{str}
+
     @ivar options: Configurations options for nodes, subscriptions and publish
                    requests.
     @type options: L{data_form.Form}
+
     @ivar subscriber: The subscribing entity.
-    @type subscriber: L{JID}
+    @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
+
     @ivar subscriptionIdentifier: Identifier for a specific subscription.
     @type subscriptionIdentifier: C{unicode}
+
     @ivar subscriptions: Subscriptions to be modified, as a set of
-                         L{Subscription}.
+        L{Subscription}.
     @type subscriptions: C{set}
+
     @ivar affiliations: Affiliations to be modified, as a dictionary of entity
-                        (L{JID} to affiliation (C{unicode}).
+        (L{JID<twisted.words.protocols.jabber.jid.JID>} to affiliation
+        (C{unicode}).
     @type affiliations: C{dict}
     """
@@ -599 +610 @@
 
         @param xs: The XML stream to send the request on.
-        @type xs: L{xmlstream.XmlStream}
+        @type xs: L{twisted.words.protocols.jabber.xmlstream.XmlStream}
         @rtype: L{defer.Deferred}.
         """
@@ -637 +648 @@
     @type nodeIdentifier: C{unicode}
     @param headers: SHIM headers, see L{wokkel.shim.extractHeaders}.
-    @type headers: L{dict}
+    @type headers: C{dict}
     """
 
@@ -758 +769 @@
 
         @param service: The publish subscribe service to create the node at.
-        @type service: L{JID}
+        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
         @param nodeIdentifier: Optional suggestion for the id of the node.
         @type nodeIdentifier: C{unicode}
@@ -793 +804 @@
 
         @param service: The publish subscribe service to delete the node from.
-        @type service: L{JID}
+        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
         @param nodeIdentifier: The identifier of the node.
         @type nodeIdentifier: C{unicode}
@@ -810 +821 @@
 
         @param service: The publish subscribe service that keeps the node.
-        @type service: L{JID}
+        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param nodeIdentifier: The identifier of the node.
@@ -817 +828 @@
         @param subscriber: The entity to subscribe to the node. This entity
             will get notifications of new published items.
-        @type subscriber: L{JID}
+        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param options: Subscription options.
@@ -862 +873 @@
 
         @param service: The publish subscribe service that keeps the node.
-        @type service: L{JID}
+        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param nodeIdentifier: The identifier of the node.
@@ -868 +879 @@
 
         @param subscriber: The entity to unsubscribe from the node.
-        @type subscriber: L{JID}
+        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param subscriptionIdentifier: Optional subscription identifier.
@@ -887 +898 @@
 
         @param service: The publish subscribe service that keeps the node.
-        @type service: L{JID}
+        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
         @param nodeIdentifier: The identifier of the node.
         @type nodeIdentifier: C{unicode}
@@ -907 +918 @@
 
         @param service: The publish subscribe service that keeps the node.
-        @type service: L{JID}
+        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param nodeIdentifier: The identifier of the node.
@@ -946 +957 @@
 
         @param service: The publish subscribe service that keeps the node.
-        @type service: L{JID}
+        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param nodeIdentifier: The identifier of the node.
@@ -952 +963 @@
 
         @param subscriber: The entity subscribed to the node.
-        @type subscriber: L{JID}
+        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param subscriptionIdentifier: Optional subscription identifier.
@@ -983 +994 @@
 
         @param service: The publish subscribe service that keeps the node.
-        @type service: L{JID}
+        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param nodeIdentifier: The identifier of the node.
@@ -989 +1000 @@
 
         @param subscriber: The entity subscribed to the node.
-        @type subscriber: L{JID}
+        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
 
         @param options: Subscription options.
@@ -1022 +1033 @@
     subscriptions, and sending out notifications.
 
-    Methods from the L{IPubSubService} interface that are called as
-    a result of an XMPP request may raise exceptions. Alternatively the
-    deferred returned by these methods may have their errback called. These are
-    handled as follows:
+    Methods from the L{IPubSubService} interface that are called as a result
+    of an XMPP request may raise exceptions. Alternatively the deferred
+    returned by these methods may have their errback called. These are handled
+    as follows:
 
      - If the exception is an instance of L{error.StanzaError}, an error