Skip to content
This repository was archived by the owner on Dec 16, 2022. It is now read-only.

Commit 8b07c42

Browse files
authored
Improve error message for "undocumented modules" (#2427)
1 parent 585c19e commit 8b07c42

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

scripts/check_docs.py

+3
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,7 @@ def existing_modules(module_glob: str = MODULE_GLOB) -> Set[str]:
7171
success = False
7272

7373
if not success:
74+
print("To pass this check, you must add a reference to undocumented modules in our API "
75+
"documentation in the appropriate place under doc/api (typically, these are modules "
76+
"that you added in this PR), and remove any reference to modules that you deleted.")
7477
sys.exit(1)

0 commit comments

Comments
 (0)