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/validation.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'webmentions_ssg/validation.py') diff --git a/webmentions_ssg/validation.py b/webmentions_ssg/validation.py index e39d4d5..d1d8129 100644 --- a/webmentions_ssg/validation.py +++ b/webmentions_ssg/validation.py @@ -8,5 +8,9 @@ import unicodedata def is_control_character(character: str) -> bool: - """Identify Unicode control characters, including C0, DEL, and C1.""" + """Identify Unicode control characters, including C0, DEL, and C1. + + :param character: Unicode character to classify. + :returns: ``True`` for C0, DEL, or C1 control characters. + """ return unicodedata.category(character) == "Cc" -- cgit v1.3.1