Improved help strings, add doc url

diff --git a/sid/__init__.py b/sid/__init__.py
index 70346915a9f33a36002795a261a7bedeca7d4d70..8c763c88643fcc3f307bba77d54bca67439e013e 100644 (file)
--- a/sid/__init__.py
+++ b/sid/__init__.py
@@ -9,3 +9,4 @@ __description__ = 'An xmpp bot based on slixmpp'
 # https://www.python.org/dev/peps/pep-0440/
 __version__ = '0.1.2'
 __url__ = 'http://git.kaliko.me/?p=sid.git'
+__doc__ = 'https://kaliko.gitlab.io/sid/'

diff --git a/sid/feeds.py b/sid/feeds.py
index 5494a95e6daf0f7e386b354abfcb36df4dd85e7d..9dc7ea1538e8574f8f864daa9fc74338b27f5a8a 100644 (file)
--- a/sid/feeds.py
+++ b/sid/feeds.py
@@ -163,7 +163,7 @@ class Feeds(Plugin):
 
     @botcmd
     def feeds(self, rcv, args):
-        """feeds monitors debian project related feeds.
+        """Monitors debian project related feeds.
 
         * ``!feeds``      : registred feeds list
         * ``!feeds last`` : last check time"""

diff --git a/sid/ping.py b/sid/ping.py
index a641c83108206543c1631546a10b78e2bfe3cb61..eea657667eee0d83a5fde2730a1271f29e73c06a 100644 (file)
--- a/sid/ping.py
+++ b/sid/ping.py
@@ -25,7 +25,7 @@ class Ping(Plugin):
 
     @botcmd
     def ping(self, rcv, args):
-        """ping's answering a pong showing the bot is alive.
+        """Answers a pong showing the bot is alive.
 
         !ping : You'll get back "pong"!
         """

diff --git a/sid/sid.py b/sid/sid.py
index a3ca555e891602c839ababae1097635676a08e75..2d64932838b3813da553e4fa6d5280f55d527335 100644 (file)
--- a/sid/sid.py
+++ b/sid/sid.py
@@ -23,7 +23,7 @@ import traceback
 
 import slixmpp
 
-from sid import __url__
+from sid import __url__, __doc__
 
 
 def botcmd(*args, **kwargs):
@@ -210,6 +210,7 @@ class MUCBot(slixmpp.ClientXMPP):
         Automatically assigned to the "help" command."""
         help_cmd = ('Type {}help <command name>'.format(self.prefix) +
                     ' to get more info about that specific command.\n\n' +
+                    f'DOC: {__doc__}\n' +
                     f'SRC: {__url__}')
         if not args:
             if self.__doc__: