Merge pull request NixOS#115879 from khumba/doc-black-disable

nixos/manual/writing-nixos-tests: document how to disable Black silently
onsails · Mar 11, 2021 · 540af5f · 540af5f
2 parents 23f3456 + d3ea5a7
commit 540af5f
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/nixos/doc/manual/development/writing-nixos-tests.xml b/nixos/doc/manual/development/writing-nixos-tests.xml
@@ -448,6 +448,17 @@ import ./make-test-python.nix {
       <replaceable>Python code…</replaceable>
     '';
 }
+</programlisting>
+  This will produce a Nix warning at evaluation time. To fully disable the
+  linter, wrap the test script in comment directives to disable the Black linter
+  directly (again, don't commit this within the Nixpkgs repository):
+<programlisting>
+  testScript =
+    ''
+      # fmt: off
+      <replaceable>Python code…</replaceable>
+      # fmt: on
+    '';
 </programlisting>
  </para>
 </section>