From: kaliko <kaliko@azylum.org>
Date: Fri, 2 Oct 2020 11:07:53 +0000 (+0200)
Subject: Improved help strings, add doc url
X-Git-Tag: 0.2.0~5
X-Git-Url: https://git.kaliko.me/?p=sid.git;a=commitdiff_plain;h=8500ad64bdcd5e03de1936f10334ec8b49e0840e

Improved help strings, add doc url
---

diff --git a/sid/__init__.py b/sid/__init__.py
index 7034691..8c763c8 100644
--- 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 5494a95..9dc7ea1 100644
--- 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 a641c83..eea6576 100644
--- 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 a3ca555..2d64932 100644
--- 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__: