amorfo77/json
1
0
Fork 0
mirror of https://github.com/nlohmann/json.git synced 2026-10-05 06:00:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use one-line module docstrings in the API checker scripts

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
tools/api_checker/snapshot_release.py
+7 -9
View File
@@ -1,14 +1,12 @@
#!/usr/bin/env python3
"""
Capture immutable, per-release API surface records into tools/api_checker/history/.
"""Capture immutable, per-release API surface records into tools/api_checker/history/."""
These are the durable, committed counterpart to diff_api.py's live git-archive-and-extract path:
once a release is tagged, run this once to capture tools/api_checker/history/<tag>.json, commit
it, and future diffs against that tag hit the fast, no-libclang-needed stored-file path in
diff_api.py automatically. See tools/api_checker/README.md's "Workflow: Release Checklist" and
POLICY.md for the full policy (manual step, not CI-automated; files are immutable once committed
-- regenerate only via --force, and only as a deliberate, reviewed choice).
"""
# These are the durable, committed counterpart to diff_api.py's live git-archive-and-extract path:
# once a release is tagged, run this once to capture tools/api_checker/history/<tag>.json, commit
# it, and future diffs against that tag hit the fast, no-libclang-needed stored-file path in
# diff_api.py automatically. See tools/api_checker/README.md's "Workflow: Release Checklist" and
# POLICY.md for the full policy (manual step, not CI-automated; files are immutable once committed
# -- regenerate only via --force, and only as a deliberate, reviewed choice).
import argparse
import datetime