plugin XEP-0277: clarify a docstring for one complex method argument

This commit is contained in:
souliane 2015-09-10 07:35:43 +02:00
commit d747c144cd

View file

@ -708,13 +708,13 @@ class XEP_0277(object):
@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