diff options
| author | Maximilian Ehlers <2843450+b-m-f@users.noreply.github.com> | 2023-09-14 16:59:20 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-14 16:59:20 +0200 |
| commit | a29cf4aece7ed0f497f600faec9614c6feb5159b (patch) | |
| tree | 97b39b071d1f6ac1305b1fbe3e0a0045bd2ebd83 /doc | |
| parent | c8430909172201d1e24688aeef57d5de624e196d (diff) | |
Link to usage of pkg description instead of referring to nix-env (#255127)
* 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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/stdenv/meta.chapter.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/stdenv/meta.chapter.md b/doc/stdenv/meta.chapter.md index f6da0bb84be04..b05dcd4c0a99e 100644 --- a/doc/stdenv/meta.chapter.md +++ b/doc/stdenv/meta.chapter.md @@ -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. |