changeset 854:762b191e1e1e

plugin XEP-0277: added missing docstring
author Goffi <goffi@goffi.org>
date Sun, 23 Feb 2014 23:30:35 +0100
parents c2f6ada7858f
children 03addfe98b64
files src/plugins/plugin_xep_0277.py
diffstat 1 files changed, 7 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/src/plugins/plugin_xep_0277.py	Sun Feb 23 23:30:32 2014 +0100
+++ b/src/plugins/plugin_xep_0277.py	Sun Feb 23 23:30:35 2014 +0100
@@ -71,6 +71,12 @@
                               doc={})
 
     def parseCommentUrl(self, node_url):
+        """Determine the fields comments_service and comments_node of a microblog data
+        from the href attribute of an entry's link element. For example this input:
+        xmpp:sat-pubsub.libervia.org?node=urn%3Axmpp%3Acomments%3A_c5c4a142-2279-4b2a-ba4c-1bc33aa87634__urn%3Axmpp%3Agroupblog%3Asouliane%libervia.org
+        will return (JID(u'sat-pubsub.libervia.org'), 'urn:xmpp:comments:_c5c4a142-2279-4b2a-ba4c-1bc33aa87634__urn:xmpp:groupblog:souliane%libervia.org')
+        @return: a tuple (JID, str)
+        """
         parsed_url = urlparse.urlparse(node_url, 'xmpp')
         service = jid.JID(parsed_url.path)
         queries = parsed_url.query.split(';')
@@ -154,7 +160,7 @@
                         microblog_data['comments_node'] = node
                         break
                 except (KeyError, exceptions.DataError, RuntimeError):
-                    warning("Can't parse link")
+                    warning(_("Can't parse the link element of pubsub entry %s") % item['id'])
                     continue
         except (AttributeError, KeyError):
             error(_('Error while parsing atom entry for microblogging event'))