Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: inconsistent docstring headings confuse type annotation checking tools #126

Merged
merged 1 commit into from
Jun 1, 2024
Merged

fix: inconsistent docstring headings confuse type annotation checking tools #126

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions spond/spond.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

"""
Expand Down Expand Up @@ -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"
Expand All @@ -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}"
Expand Down