movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-09 11:03:15 +03:00
Code Issues Projects Releases Packages Wiki Activity

docs/language-frameworks/python: clarify how to best comment on disabled tests

Browse source
This commit is contained in:
Peder Bergebakken Sundt 2025-06-09 04:17:54 +02:00
parent 5682734cc3
commit c92582fcbb
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
doc/languages-frameworks/python.section.md
View file

@ -2180,7 +2180,8 @@ The following rules are desired to be respected:
* Make sure the tests are enabled using for example [`pytestCheckHook`](#using-pytestcheckhook) and, in the case of
libraries, are passing for all interpreters. If certain tests fail they can be
disabled individually. Try to avoid disabling the tests altogether. In any
case, when you disable tests, leave a comment explaining why.
case, when you disable tests, leave a comment explaining not only _what_ the failure
is but _why_ the test failure can be ignored for safe distribution with nixpkgs.
* `pythonImportsCheck` is set. This is still a good smoke test even if `pytestCheckHook` is set.
* `meta.platforms` takes the default value in many cases.
It does not need to be set explicitly unless the package requires a specific platform.