aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg/__init__.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/__init__.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/__init__.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/webmentions_ssg/__init__.py b/webmentions_ssg/__init__.py
index 83e3f12..223f35d 100644
--- a/webmentions_ssg/__init__.py
+++ b/webmentions_ssg/__init__.py
@@ -32,8 +32,8 @@ def create_app(config_class: type[DefaultConfig] | None = None) -> Flask:
initialized.
:param config_class: Configuration class to use, or ``None`` to select the
- development or production configuration automatically.
- :return: Configured Flask application.
+ development or production configuration automatically.
+ :returns: Configured Flask application.
"""
development = os.environ.get("WEBMENTIONS_SSG_DEV", "").lower() in {
"1",
@@ -119,7 +119,7 @@ def create_app(config_class: type[DefaultConfig] | None = None) -> Flask:
def inject_version():
"""Add the application version to the template context.
- :return: Template context containing the application version.
+ :returns: Template context containing the application version.
"""
return {"VERSION": VERSION}