From 58736954d11470fd51e702cfffe1b6820e689fe2 Mon Sep 17 00:00:00 2001 From: Oliver Hartmann Date: Sun, 14 Mar 2021 14:10:45 +0100 Subject: [PATCH] documentation --- src/sendkeys.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/sendkeys.py b/src/sendkeys.py index 142854f..cc0b80a 100644 --- a/src/sendkeys.py +++ b/src/sendkeys.py @@ -23,12 +23,12 @@ def send_to(user: str, text: str) -> None: def send_to_format(type: str, message: data.Message, conf: dict()) -> None: - """[summary] + """Send a message defined in the conf dict to a user Args: - type (str): [description] - message (data.Message): [description] - conf (dict): [description] + type (str): The type of message. This is defined in conf['Chat']. + message (data.Message): Message data. Placeholders in the message type will be replaced with this data. + conf (dict): Configution dictionary where the messages are stored. """ text = conf['Chat'][type].format(message=message.message, date=message.date,