Use one-line module docstrings in the API checker scripts

Codacy runs two docstring checkers with opposite rules for module
docstrings: with the summary on the first line it reported D213, with
the summary on the second line it reports D212. A one-line docstring
satisfies both. Keep the summary as the docstring and move the details
into a comment below it; nothing reads the module docstrings.

Signed-off-by: Niels Lohmann <mail@nlohmann.me>
This commit is contained in:
Niels Lohmann
2026-09-28 18:42:34 +02:00
parent da5097abcd
commit 4c73319d3b
5 changed files with 57 additions and 67 deletions
+5 -7
View File
@@ -1,12 +1,10 @@
#!/usr/bin/env python3
"""
Verify that public API entries have documentation links.
"""Verify that public API entries have documentation links."""
Consumes an API snapshot from extract_api.py and checks:
1. Every public callable/type-tier entry has an @sa comment (with exceptions)
2. Every @sa URL resolves to an existing documentation file
3. No @sa comments appear on non-public entities
"""
# Consumes an API snapshot from extract_api.py and checks:
# 1. Every public callable/type-tier entry has an @sa comment (with exceptions)
# 2. Every @sa URL resolves to an existing documentation file
# 3. No @sa comments appear on non-public entities
import argparse
import json