From b58bc8c2a9a316891a5ea1a0487aebfc86c2793a Mon Sep 17 00:00:00 2001 From: Dong-hee Na Date: Wed, 17 May 2023 12:56:20 +0900 Subject: [PATCH] gh-104469: Update README.txt for _testcapi (gh-104529) * gh-104469: Update README.txt for _testcapi Co-authored-by: Erlend E. Aasland Co-authored-by: Kirill Podoprigora --- Modules/_testcapi/README.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Modules/_testcapi/README.txt b/Modules/_testcapi/README.txt index 134b6efc638..8a65e7abf77 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.