Skip to content

Commit 19bbe0b

Browse files
committed
doc/meta: make meta.description consistent with contributing document
1 parent 3c89ee1 commit 19bbe0b

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

doc/stdenv/meta.chapter.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,32 @@ Meta-attributes are not passed to the builder of the package. Thus, a change to
2222

2323
## Standard meta-attributes {#sec-standard-meta-attributes}
2424

25+
If the package is to be submitted to Nixpkgs, please check out the
26+
[requirements for meta attributes](https://github.com/NixOS/nixpkgs/tree/master/pkgs#meta-attributes)
27+
in the contributing documentation.
28+
2529
It is expected that each meta-attribute is one of the following:
2630

2731
### `description` {#var-meta-description}
2832

2933
A short (one-line) description of the package.
3034
This is displayed on [search.nixos.org](https://search.nixos.org/packages).
3135

32-
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.
36+
The general requirements of a description are:
37+
38+
- Be short, just one sentence.
39+
- Be capitalized.
40+
- Not start with definite ("The") or indefinite ("A"/"An") article.
41+
- Not start with the package name.
42+
- More generally, it should not refer to the package name.
43+
- Not end with a period (or any punctuation for that matter).
44+
- Provide factual information.
45+
- Avoid subjective language.
46+
3347

3448
Wrong: `"libpng is a library that allows you to decode PNG images."`
3549

36-
Right: `"A library for decoding PNG images"`
50+
Right: `"Library for decoding PNG images"`
3751

3852
### `longDescription` {#var-meta-longDescription}
3953

0 commit comments

Comments
 (0)