Skip to content

Commit 51b2747

Browse files
Apply suggestions from code review
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
1 parent 2510476 commit 51b2747

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

Makefile.pre.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3314,7 +3314,7 @@ check-c-globals:
33143314
--traceback
33153315

33163316
# Check for undocumented C APIs.
3317-
.PHONY: check-c-globals
3317+
.PHONY: check-c-api-docs
33183318
check-c-api-docs:
33193319
$(PYTHON_FOR_REGEN) $(srcdir)/Tools/check-c-api-docs/main.py
33203320

Tools/check-c-api-docs/main.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99
SIMPLE_DATA_REGEX = re.compile(r"PyAPI_DATA\(.+\) (\w+)")
1010

1111
MISTAKE = """\
12-
If this is a mistake and this script should not be failing, please create an
12+
If this is a mistake and this script should not be failing, create an
1313
issue and tag Peter (@ZeroIntensity) on it.\
1414
"""
1515

1616
FOUND_UNDOCUMENTED = f"""\
1717
Found some undocumented C API(s)!
1818
1919
Python requires documentation on all public C API symbols, macros, and types.
20-
If these API(s) were not meant to be public, please prefix them with a
20+
If these API(s) were not meant to be public, prefix them with a
2121
leading underscore (_PySomething_API) or move them to the internal C API
2222
(pycore_*.h files).
2323
@@ -29,8 +29,8 @@
2929

3030
FOUND_IGNORED_DOCUMENTED = f"""\
3131
Some C API(s) were listed in Tools/c-api-docs-check/ignored_c_api.txt, but
32-
they were found in the documentation. To fix this, simply update ignored_c_api.txt
33-
accordingly.
32+
they were found in the documentation. To fix this, remove them from
33+
ignored_c_api.txt.
3434
3535
{MISTAKE}\
3636
"""
@@ -112,7 +112,7 @@ def check_for_name(name: str) -> None:
112112

113113
check_for_name(name)
114114

115-
# Remove duplicates and sort alphabetically to keep the output non-deterministic
115+
# Remove duplicates and sort alphabetically to keep the output deterministic
116116
undocumented = list(set(undocumented))
117117
undocumented.sort()
118118

0 commit comments

Comments
 (0)