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. --- webmentions_ssg/db_helpers.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'webmentions_ssg/db_helpers.py') diff --git a/webmentions_ssg/db_helpers.py b/webmentions_ssg/db_helpers.py index 6e1c2d2..d4cc148 100644 --- a/webmentions_ssg/db_helpers.py +++ b/webmentions_ssg/db_helpers.py @@ -10,5 +10,9 @@ from sqlalchemy.engine import CursorResult, Result def rows_affected(result: Result[Any]) -> int: - """Return the row count from a SQL UPDATE or DELETE result.""" + """Return the row count from a SQL UPDATE or DELETE result. + + :param result: SQLAlchemy result of an UPDATE or DELETE operation. + :returns: Number of rows affected by the statement. + """ return cast(CursorResult[Any], result).rowcount -- cgit v1.3.1