From 0a3844360f666ecdf58958081e406b03b4113b46 Mon Sep 17 00:00:00 2001 From: Elliot <3186037+elliot-100@users.noreply.github.com> Date: Sat, 1 Jun 2024 17:51:29 +0100 Subject: [PATCH] fix: inconsistent docstring headings confuse type annotation checking tools --- spond/spond.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/spond/spond.py b/spond/spond.py index dba9202..15cc8fe 100644 --- a/spond/spond.py +++ b/spond/spond.py @@ -307,15 +307,15 @@ async def update_event(self, uid, updates: dict): """ Updates an existing event. - Parameters: + Parameters ---------- uid : str UID of the event. updates : dict The changes. e.g. if you want to change the description -> {'description': "New Description with changes"} - Returns: - ---------- + Returns + ------- json results of post command """ @@ -389,7 +389,8 @@ async def get_event_attendance_xlsx(self, uid: str) -> bytes: uid : str UID of the event. - Returns: + Returns + ------- bytes: XLSX binary data """ url = f"{self.api_url}sponds/{uid}/export" @@ -413,7 +414,7 @@ async def change_response(self, uid: str, user: str, payload: dict) -> dict: user response to event, e.g. {"accepted": "true"} Returns - ---------- + ------- json: event["responses"] with updated info """ url = f"{self.api_url}sponds/{uid}/responses/{user}"