New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
stdenv/check-meta: description may not end in period #123015
base: master
Are you sure you want to change the base?
Conversation
Command run: sed -i -r 's/(description\s*=\s*)"([^"]*)\."/\1"\2"/g' pkgs/**/*.nix
c8975db
to
c705982
Compare
Manually take care of the remaining cases.
c705982
to
2638220
Compare
We certainly can strip dots in cabal2nix. (I mean why wouldn‘t we?) What confuses me is this commit message (that I vaguely remembered) which claims to already have fixed this. But apparently there still are packages with a dot at the end. NixOS/cabal2nix@2a4560c |
@maralorn https://github.com/NixOS/cabal2nix/blob/e18310f2eae5d2d7b73512b0b75396224fbf76ca/src/Distribution/Nixpkgs/Haskell/FromCabal/Normalize.hs#L36 looks like dots are only removed from the end if there is at most one dot in the description. I see no reason for that restriction. |
Technically speaking, only one dot is «full stop» punctuation, multiple dots are ellipsis, which has some meaning beyond «the sentenceends here» |
That's not the only case though: For example, some descriptions contain the word "tar.gz" end a single period at the end. I could change the regex to |
Hmm, stupid question: will this also apply to external overlays? |
Only if they set |
I marked this as stale due to inactivity. → More info |
Motivation for this change
in accordance with https://nixos.org/manual/nixpkgs/unstable/#var-meta-description and https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#submitting-changes
Things done
sandbox
innix.conf
on non-NixOS linux)nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
./result/bin/
)nix path-info -S
before and after)The main problem I came across was
hackage-packages.nix
. Maybe we can automatically remove periods (and probably whitespace) from the end of desciptions upon generating it?cc @NixOS/haskell
The same goes for the packages in
pkgs/development/lisp-modules/quicklisp-to-nix-output/split-sequence.nix
.cc @7c6f434c
... and for poetry2nix
cc @adisbladis