Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-104469: Update README.txt for _testcapi #104529

Merged
merged 3 commits into from
May 17, 2023
+7 −0
Merged

gh-104469: Update README.txt for _testcapi #104529

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f62fb02
gh-104469: Update README.txt for _testcapi
corona10 May 16, 2023
62531ef
nit
corona10 May 16, 2023
03936c8
Apply suggestions from code review
corona10 May 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Modules/_testcapi/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
Tests in this directory are compiled into the _testcapi extension.
The main file for the extension is Modules/_testcapimodule.c, which
calls `_PyTestCapi_Init_*` from these functions.

General guideline when writing test code for C API.
* Use Argument Clinic to minimise the amount of boilerplate code.
* Add a newline between the argument spec and the docstring.
* If a test description is needed, make sure the added docstring clearly and succinctly describes purpose of the function.
* DRY, use the clone feature of Argument Clinic.
* Try to avoid adding new interned strings; reuse existing parameter names if possible. Use the `as` feature of Argument Clinic to override the C variable name, if needed.