Briefly document all plugins

stdplugins/all.py

@@ -1,7 +1,9 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
+"""
+Mentions .all people in the group
+"""
 from telethon import events
 
 

stdplugins/chain.py

@@ -1,7 +1,9 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
+"""
+Counts how long a reply .chain is
+"""
 from collections import defaultdict
 
 from telethon import events

stdplugins/fixreply.py

@@ -1,6 +1,9 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
+"""
+Reply with .fixreply to adjust your last message's reply
+"""
 import asyncio
 
 from telethon import events

stdplugins/fpost.py

@@ -1,7 +1,9 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
+"""
+.fpost a message with single-letter forwards
+"""
 import string
 
 from telethon import events

stdplugins/info.py

@@ -1,7 +1,9 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
+"""
+Show all .info about the replied message
+"""
 from telethon import events
 from telethon.utils import add_surrogate
 from telethon.tl.types import MessageEntityPre

stdplugins/markdown.py

@@ -1,6 +1,9 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
+"""
+Enhances your markdown capabilities
+"""
 import re
 from functools import partial
 

stdplugins/music_fix.py

@@ -1,7 +1,9 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
+"""
+Auto-fix audio files sent as voice-notes
+"""
 from telethon import events
 
 @borg.on(events.NewMessage(outgoing=True))

stdplugins/ninja.py

@@ -1,7 +1,9 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
+"""
+Perform ninja deletions or edits
+"""
 import asyncio
 
 from telethon import events

stdplugins/randomsticker.py

@@ -1,7 +1,9 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
+"""
+Send a random .brain or .dab sticker
+"""
 import random
 
 from telethon import events, types, functions, utils
@@ -44,4 +46,4 @@ choser('dab', 'DabOnHaters', {
 choser('fp', 'facepalmstickers', {
     285892071401720411,
     285892071401725809
-})
+})

stdplugins/sed.py

@@ -1,3 +1,6 @@
+"""
+Become @regexbot when the bot is missing
+"""
 from collections import defaultdict, deque
 import re
 

stdplugins/snip.py

@@ -1,6 +1,9 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
+"""
+.snips-ave snips and send them with .snip name
+"""
 import asyncio
 from telethon import events, utils
 from telethon.tl import types

stdplugins/who.py

@@ -1,7 +1,9 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
+"""
+Show information about the chat or replied user
+"""
 import datetime
 import html
 import time