diff options
| author | Dong-hee Na <donghee.na@python.org> | 2023-05-17 12:56:20 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-17 12:56:20 +0900 |
| commit | b58bc8c2a9a316891a5ea1a0487aebfc86c2793a (patch) | |
| tree | e9eff0906e0e48a26f4974bb6cb1f51a9aec27ee | |
| parent | 1b5a2b085c28d230c9ef9bd9b472afc85e087ced (diff) | |
| download | cpython-git-b58bc8c2a9a316891a5ea1a0487aebfc86c2793a.tar.gz | |
gh-104469: Update README.txt for _testcapi (gh-104529)
* gh-104469: Update README.txt for _testcapi
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
| -rw-r--r-- | Modules/_testcapi/README.txt | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Modules/_testcapi/README.txt b/Modules/_testcapi/README.txt index 134b6efc63..8a65e7abf7 100644 --- a/Modules/_testcapi/README.txt +++ b/Modules/_testcapi/README.txt @@ -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. |