aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg/forms.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/forms.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 'webmentions_ssg/forms.py')
-rw-r--r--webmentions_ssg/forms.py6
1 files changed, 5 insertions, 1 deletions
diff --git a/webmentions_ssg/forms.py b/webmentions_ssg/forms.py
index f5fba51..e3dcdc0 100644
--- a/webmentions_ssg/forms.py
+++ b/webmentions_ssg/forms.py
@@ -143,7 +143,11 @@ class EndpointForm(FlaskForm):
)
def validate_source(self, field: Field) -> None:
- """Reject a source URL that equals the target URL."""
+ """Reject a source URL that equals the target URL.
+
+ :param field: Source URL field being validated.
+ :raises ValidationError: If the source URL equals the target URL.
+ """
if field.data == self.target.data:
raise ValidationError(field.gettext("Field must not be equal to target."))