public
/
nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

nixos/manual/writing-nixos-tests: document how to disable Black silently
This commit is contained in:
Florian Klink 2021-03-11 16:18:17 +01:00 committed by GitHub
parent 23f345643e d3ea5a7290
commit 540af5fe05
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
nixos/doc/manual/development/writing-nixos-tests.xml
View File

@ -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>