comparison src/plugins/plugin_xep_0277.py @ 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 4c4f88d7b156
children 955221487a3e
comparison
equal deleted inserted replaced
1510:91631837ce5c 1511:83f71763e1a7
706 """Get real-time results for [mbGetFromManyWithComments] session 706 """Get real-time results for [mbGetFromManyWithComments] session
707 707
708 @param session_id: id of the real-time deferred session 708 @param session_id: id of the real-time deferred session
709 @param return (tuple): (remaining, results) where: 709 @param return (tuple): (remaining, results) where:
710 - remaining is the number of still expected results 710 - remaining is the number of still expected results
711 - results is a list of tuple with 711 - results is a list of 5-tuple with
712 - service (unicode): pubsub service 712 - service (unicode): pubsub service
713 - node (unicode): pubsub node 713 - node (unicode): pubsub node
714 - failure (unicode): empty string in case of success, error message else 714 - failure (unicode): empty string in case of success, error message else
715 - items(list): list of items with: 715 - items(list[tuple(dict, list)]): list of 2-tuple with
716 - item(dict): item microblog data 716 - item(dict): item microblog data
717 - comments_list(list): list of comments with 717 - comments_list(list[tuple]): list of 5-tuple with
718 - service (unicode): pubsub service where the comments node is 718 - service (unicode): pubsub service where the comments node is
719 - node (unicode): comments node 719 - node (unicode): comments node
720 - failure (unicode): empty in case of success, else error message 720 - failure (unicode): empty in case of success, else error message
721 - comments(list[dict]): list of microblog data 721 - comments(list[dict]): list of microblog data
722 - comments_metadata(dict): metadata of the comment node 722 - comments_metadata(dict): metadata of the comment node