From 968e1b4e4a6fbd5a15037cdb11a3f9dee5108570 Mon Sep 17 00:00:00 2001 From: Dennis Fink Date: Sat, 14 Nov 2026 18:44:23 +0100 Subject: 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. --- .../versions/408fc2eca9ce_track_webmention_digest_notifications.py | 2 +- webmentions_ssg/migrations/versions/681a2a9a1bc0_webmention_sender.py | 2 +- .../migrations/versions/85f2b226ec99_add_webmention_retry_backoff.py | 2 +- .../versions/be6e229d6a3d_do_not_limit_username_and_password_hash_.py | 2 +- .../migrations/versions/f63641044cc1_initial_database_schema.py | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) (limited to 'webmentions_ssg/migrations') diff --git a/webmentions_ssg/migrations/versions/408fc2eca9ce_track_webmention_digest_notifications.py b/webmentions_ssg/migrations/versions/408fc2eca9ce_track_webmention_digest_notifications.py index 6f337be..5547e45 100644 --- a/webmentions_ssg/migrations/versions/408fc2eca9ce_track_webmention_digest_notifications.py +++ b/webmentions_ssg/migrations/versions/408fc2eca9ce_track_webmention_digest_notifications.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: BSD-3-Clause -"""Track webmention digest notifications +"""Track webmention digest notifications. Revision ID: 408fc2eca9ce Revises: be6e229d6a3d diff --git a/webmentions_ssg/migrations/versions/681a2a9a1bc0_webmention_sender.py b/webmentions_ssg/migrations/versions/681a2a9a1bc0_webmention_sender.py index 0a77094..9522337 100644 --- a/webmentions_ssg/migrations/versions/681a2a9a1bc0_webmention_sender.py +++ b/webmentions_ssg/migrations/versions/681a2a9a1bc0_webmention_sender.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: BSD-3-Clause -"""Webmention sender +"""Webmention sender. Revision ID: 681a2a9a1bc0 Revises: f63641044cc1 diff --git a/webmentions_ssg/migrations/versions/85f2b226ec99_add_webmention_retry_backoff.py b/webmentions_ssg/migrations/versions/85f2b226ec99_add_webmention_retry_backoff.py index 66fa289..d5ad4dc 100644 --- a/webmentions_ssg/migrations/versions/85f2b226ec99_add_webmention_retry_backoff.py +++ b/webmentions_ssg/migrations/versions/85f2b226ec99_add_webmention_retry_backoff.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: BSD-3-Clause -"""Add Webmention retry backoff +"""Add Webmention retry backoff. Revision ID: 85f2b226ec99 Revises: 408fc2eca9ce diff --git a/webmentions_ssg/migrations/versions/be6e229d6a3d_do_not_limit_username_and_password_hash_.py b/webmentions_ssg/migrations/versions/be6e229d6a3d_do_not_limit_username_and_password_hash_.py index 3ba49dd..058fe18 100644 --- a/webmentions_ssg/migrations/versions/be6e229d6a3d_do_not_limit_username_and_password_hash_.py +++ b/webmentions_ssg/migrations/versions/be6e229d6a3d_do_not_limit_username_and_password_hash_.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: BSD-3-Clause -"""Do not limit username and password hash length +"""Do not limit username and password hash length. Revision ID: be6e229d6a3d Revises: 681a2a9a1bc0 diff --git a/webmentions_ssg/migrations/versions/f63641044cc1_initial_database_schema.py b/webmentions_ssg/migrations/versions/f63641044cc1_initial_database_schema.py index b6064fe..c678c39 100644 --- a/webmentions_ssg/migrations/versions/f63641044cc1_initial_database_schema.py +++ b/webmentions_ssg/migrations/versions/f63641044cc1_initial_database_schema.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: BSD-3-Clause -"""Initial database schema +"""Initial database schema. Revision ID: f63641044cc1 Revises: -- cgit v1.3.1