Skip to content

Commit

Permalink
pythongh-104469: Update README.txt for _testcapi
Browse files Browse the repository at this point in the history
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
  • Loading branch information
corona10 and erlend-aasland committed May 16, 2023
1 parent 24d8b88 commit f62fb02
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 for writing test C API.
* Use clinic tool as possible.
* Add a newline between the the argument spec and the docstring.
* If a test decription 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 and use the `as` feature to override the C name.

0 comments on commit f62fb02

Please sign in to comment.