Skip to content

Commit

Permalink
pythongh-104469: Update README.txt for _testcapi (pythongh-104529)
Browse files Browse the repository at this point in the history
* pythongh-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>
  • Loading branch information
3 people authored and JelleZijlstra committed May 18, 2023
1 parent f98dfcc commit b5430d3
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions Modules/_testcapi/README.txt
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.

0 comments on commit b5430d3

Please sign in to comment.