archives/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2026-03-13 23:06:35 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

doc: update references to nixfmt-rfc-style to treefmt

Browse source 
This completes https://github.com/NixOS/nixpkgs/issues/425583.

Rather than putting `nixfmt` everywhere, I opted to teach people to use
`treefmt` instead. This is more correct, as we have formatting rules for
non-nix files, and also may invoke `nixfmt` with non-default options.
This commit is contained in:
Jeremy Fleischman 2026-02-03 11:58:06 -08:00
parent 58b187378d
commit 2b115ef0cc
No known key found for this signature in database
5 changed files with 9 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2136,7 +2136,7 @@ The following rules are desired to be respected:
* `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.
* The file is formatted with `nixfmt-rfc-style`.
* The file is formatted correctly (e.g., `nix-shell --run treefmt`).
* Commit names of Python libraries must reflect that they are Python
libraries (e.g. `python3Packages.numpy: 1.11 -> 1.12` rather than `numpy: 1.11 -> 1.12`).
See also [`pkgs/README.md`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#commit-conventions).