aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg/views/session.py
diff options
context:
space:
mode:
authorDennis Fink2026-11-14 18:44:23 +0100
committerDennis Fink2026-11-14 18:44:23 +0100
commit968e1b4e4a6fbd5a15037cdb11a3f9dee5108570 (patch)
tree0096a0125c4d94a047e5bd24288e1f3f4a58ada5 /webmentions_ssg/views/session.py
parent2366d455c7d1ae16c84e0bcbffb94ed762c16832 (diff)
downloadwebmentions-ssg-968e1b4e4a6fbd5a15037cdb11a3f9dee5108570.tar.gz
webmentions-ssg-968e1b4e4a6fbd5a15037cdb11a3f9dee5108570.zip
docs(core): standardize reST docstrings
Expand function and method documentation with consistent reST parameter, return, and exception fields while clarifying behavior where additional context is useful. Normalize test and migration docstrings to the same documentation conventions.
Diffstat (limited to '')
-rw-r--r--webmentions_ssg/views/session.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/webmentions_ssg/views/session.py b/webmentions_ssg/views/session.py
index 870c967..371997d 100644
--- a/webmentions_ssg/views/session.py
+++ b/webmentions_ssg/views/session.py
@@ -21,7 +21,7 @@ from .blueprint import root_page
def index() -> ResponseReturnValue:
"""Redirect to the received Webmentions view.
- :return: Redirect response to the received Webmentions view.
+ :returns: Redirect response to the received Webmentions view.
"""
return redirect(url_for("root.received"))
@@ -45,7 +45,7 @@ def login() -> ResponseReturnValue:
successful login, the user is redirected to the requested local URL when
provided.
- :return: Rendered login page or redirect response.
+ :returns: Rendered login page or redirect response.
"""
if current_user.is_authenticated:
return redirect(url_for("root.index"))
@@ -77,7 +77,7 @@ def login() -> ResponseReturnValue:
def logout() -> ResponseReturnValue:
"""End the current user's login session.
- :return: Redirect response to the application index.
+ :returns: Redirect response to the application index.
"""
logout_user()
return redirect(url_for("root.index"))