sphinx: document plugins

[sid.git] / sid / bts.py

diff --git a/sid/bts.py b/sid/bts.py
index 1a7fea46640ceb48340ec85191f6085adad5d7c0..82b31d41ef5398bb8f5ab1478ceed14a115fd6f3 100644 (file)
--- a/sid/bts.py
+++ b/sid/bts.py
@@ -25,6 +25,9 @@ from .plugin import Plugin, botcmd
 
 class Bugs(Plugin):
     """Gets bugs info from the BTS
+
+    .. note::
+      This plugin depends on external module: **python-debianbts**
     """
     re_bugs = re_compile(r'(?<=#)(\d{6,7})')
     re_pkg = re_compile(r'(?P<package>[0-9a-z.+-]+)$')
@@ -35,7 +38,10 @@ class Bugs(Plugin):
                               self.bot.room, self.muc_message)
 
     def muc_message(self, msg):
-        """Handler method dealing with MUC incoming messages"""
+        """Handler method dealing with MUC incoming messages.
+
+        Intercepts bugs number in MUC messages (as #629234), replies a bug
+        summary."""
         # Does not reply to myself
         if msg['mucnick'] == self.bot.nick:
             return
@@ -66,8 +72,8 @@ class Bugs(Plugin):
 
     @botcmd
     def bugs(self, rcv, args):
-        """Intercepts bugs number in messages (as #629234), reply a bug summary.
-        !bugs pkg-name : Returns latest bug reports if any
+        """
+        **command** ``!bugs pkg-name`` : Returns latest bug reports if any
         """
         if not args:
             return