b12f/nixpkgs
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Link to usage of pkg description instead of referring to nix-env (#255127)

Browse source 
* Updates meta.chapter.md with a reference link to the usage of the package description field instead of referring to nix-env

---------

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
This commit is contained in:
Maximilian Ehlers 2023-09-14 16:59:20 +02:00 committed by GitHub
parent c843090917
commit a29cf4aece
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/stdenv/meta.chapter.md
View file

@ -24,7 +24,8 @@ It is expected that each meta-attribute is one of the following:
### `description` {#var-meta-description}
A short (one-line) description of the package. This is shown by `nix-env -q --description` and also on the Nixpkgs release pages.
A short (one-line) description of the package.
This is displayed on [search.nixos.org](https://search.nixos.org/packages).
Don’t include a period at the end. Don’t include newline characters. Capitalise the first character. For brevity, don’t repeat the name of package --- just describe what it does.