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. --- tests/test_models.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'tests/test_models.py') diff --git a/tests/test_models.py b/tests/test_models.py index 85c216e..01e2cec 100644 --- a/tests/test_models.py +++ b/tests/test_models.py @@ -27,7 +27,7 @@ from webmentions_ssg.models import ( def test_uuid_annotations_and_relationships_resolve() -> None: - """Keep UUID columns and forward relationships mapped without future annotations.""" + """Verify that UUID columns and forward relationships map correctly.""" for model in (ReceivedWebmention, Source, SentWebmention): assert get_type_hints(model)["uuid"] == Mapped[uuid.UUID] assert sa.inspect(model).columns["uuid"].primary_key -- cgit v1.3.1