mirror of
https://github.com/nlohmann/json.git
synced 2026-10-03 13:10:33 +00:00
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:
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user