From c92582fcbba8a1806e01e2f311f514936a8b088a Mon Sep 17 00:00:00 2001 From: Peder Bergebakken Sundt Date: Mon, 9 Jun 2025 04:17:54 +0200 Subject: [PATCH] docs/language-frameworks/python: clarify how to best comment on disabled tests --- doc/languages-frameworks/python.section.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/languages-frameworks/python.section.md b/doc/languages-frameworks/python.section.md index fb5f6c8e9a0b..e670702e08fa 100644 --- a/doc/languages-frameworks/python.section.md +++ b/doc/languages-frameworks/python.section.md @@ -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.