8000 gh-104469: Update README.txt for _testcapi by corona10 · Pull Request #104529 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

gh-104469: Update README.txt for _testcapi #104529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 17, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Apply suggestions from code review
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 May 16, 2023
commit 03936c861c59db32f18fba28788e0e6d3e478aeb
8 changes: 4 additions & 4 deletions Modules/_testcapi/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ 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 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.
* 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 and use the `as` feature to override the C name.
* 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