diff options
| author | Dennis Fink | 2026-11-14 18:44:23 +0100 |
|---|---|---|
| committer | Dennis Fink | 2026-11-14 18:44:23 +0100 |
| commit | 968e1b4e4a6fbd5a15037cdb11a3f9dee5108570 (patch) | |
| tree | 0096a0125c4d94a047e5bd24288e1f3f4a58ada5 /webmentions_ssg/validation.py | |
| parent | 2366d455c7d1ae16c84e0bcbffb94ed762c16832 (diff) | |
| download | webmentions-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 '')
| -rw-r--r-- | webmentions_ssg/validation.py | 6 |
1 files changed, 5 insertions, 1 deletions
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" |
