Flaschengeist/flaschengeist
Flaschengeist
/
flaschengeist
7
0
Fork 0
Code Issues 20 Pull Requests Packages Projects Releases 2 Wiki Activity

[Doc] Some more documentation on Plugin

This commit is contained in:
Ferdinand Thiessen 2020-11-01 18:43:44 +01:00
parent d439cd93c8
commit d07aa977b5
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
flaschengeist/plugins/__init__.py
View File

@ -4,13 +4,13 @@ from werkzeug.exceptions import MethodNotAllowed
from flaschengeist.hook import HookCall from flaschengeist.hook import HookCall
send_message_hook = HookCall("send_message") send_message_hook = HookCall("send_message")
"""Hook for sending messages, register to send the message """Hook decorator for sending messages, register to send the message
Args: Args:
message: Message object to send message: Message object to send
""" """
update_user_hook = HookCall("update_user") update_user_hook = HookCall("update_user")
"""When ever an user update is done, this is called before. """Hook decorator, when ever an user update is done, this is called before.
Args: Args:
user: User object user: User object
""" """
@ -18,6 +18,7 @@ Args:
class Plugin: class Plugin:
"""Base class for all Plugins""" """Base class for all Plugins"""
def __init__(self, config=None, blueprint=None, permissions=[]): def __init__(self, config=None, blueprint=None, permissions=[]):
"""Constructor called by create_app """Constructor called by create_app
Args: Args: