diff sat/plugins/plugin_misc_forums.py @ 2959:989b622faff6

plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes
author Goffi <goffi@goffi.org>
date Fri, 14 Jun 2019 12:37:34 +0200
parents 003b8b4b56a7
children ab2696e34d29
line wrap: on
line diff
--- a/sat/plugins/plugin_misc_forums.py	Wed Jun 12 09:11:28 2019 +0200
+++ b/sat/plugins/plugin_misc_forums.py	Fri Jun 14 12:37:34 2019 +0200
@@ -1,7 +1,7 @@
 #!/usr/bin/env python2
 # -*- coding: utf-8 -*-
 
-# SAT plugin for Pubsub Schemas
+# SAT plugin for pubsub forums
 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)
 
 # This program is free software: you can redistribute it and/or modify
@@ -83,7 +83,7 @@
 
     @defer.inlineCallbacks
     def _createForums(self, client, forums, service, node, forums_elt=None, names=None):
-        """recursively create <forums> element(s)
+        """Recursively create <forums> element(s)
 
         @param forums(list): forums which may have subforums
         @param service(jid.JID): service where the new nodes will be created
@@ -139,7 +139,7 @@
         defer.returnValue(forums_elt)
 
     def _parseForums(self, parent_elt=None, forums=None):
-        """recursivly parse a <forums> elements and return corresponding forums data
+        """Recursivly parse a <forums> elements and return corresponding forums data
 
         @param item(domish.Element): item with <forums> element
         @param parent_elt(domish.Element, None): element to parse
@@ -220,7 +220,7 @@
 
     @defer.inlineCallbacks
     def set(self, client, forums, service=None, node=None, forums_key=None):
-        """create or replace forums structure
+        """Create or replace forums structure
 
         @param forums(list): list of dictionary as follow:
             a dictionary represent a forum metadata, with the following keys:
@@ -254,7 +254,7 @@
 
     @defer.inlineCallbacks
     def getTopics(self, client, service, node, rsm_request=None, extra=None):
-        """retrieve topics data
+        """Retrieve topics data
 
         Topics are simple microblog URIs with some metadata duplicated from first post
         """