You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/stdenv/meta.chapter.md
+16-2Lines changed: 16 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,18 +22,32 @@ Meta-attributes are not passed to the builder of the package. Thus, a change to
22
22
23
23
## Standard meta-attributes {#sec-standard-meta-attributes}
24
24
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
+
25
29
It is expected that each meta-attribute is one of the following:
26
30
27
31
### `description` {#var-meta-description}
28
32
29
33
A short (one-line) description of the package.
30
34
This is displayed on [search.nixos.org](https://search.nixos.org/packages).
31
35
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
+
33
47
34
48
Wrong: `"libpng is a library that allows you to decode PNG images."`
0 commit comments