aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg/db_helpers.py
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--webmentions_ssg/db_helpers.py6
1 files changed, 5 insertions, 1 deletions
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