changeset 1511:83f71763e1a7

plugin XEP-0277: clarify a docstring for one complex method argument
author souliane <souliane@mailoo.org>
date Thu, 10 Sep 2015 07:35:43 +0200
parents 91631837ce5c
children fcfec24c87f3
files src/plugins/plugin_xep_0277.py
diffstat 1 files changed, 3 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/src/plugins/plugin_xep_0277.py	Thu Sep 10 07:33:13 2015 +0200
+++ b/src/plugins/plugin_xep_0277.py	Thu Sep 10 07:35:43 2015 +0200
@@ -708,13 +708,13 @@
         @param session_id: id of the real-time deferred session
         @param return (tuple): (remaining, results) where:
             - remaining is the number of still expected results
-            - results is a list of tuple with
+            - results is a list of 5-tuple with
                 - service (unicode): pubsub service
                 - node (unicode): pubsub node
                 - failure (unicode): empty string in case of success, error message else
-                - items(list): list of items with:
+                - items(list[tuple(dict, list)]): list of 2-tuple with
                     - item(dict): item microblog data
-                    - comments_list(list): list of comments with
+                    - comments_list(list[tuple]): list of 5-tuple with
                         - service (unicode): pubsub service where the comments node is
                         - node (unicode): comments node
                         - failure (unicode): empty in case of success, else error message