]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-104469: Update README.txt for _testcapi (gh-104529)
authorDong-hee Na <donghee.na@python.org>
Wed, 17 May 2023 03:56:20 +0000 (12:56 +0900)
committerGitHub <noreply@github.com>
Wed, 17 May 2023 03:56:20 +0000 (12:56 +0900)
* 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>
Modules/_testcapi/README.txt

index 134b6efc638095530bcb77b548368cd06fa2291a..8a65e7abf77009b66483e7f8377c841276d10fe2 100644 (file)
@@ -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.