diff options
| author | Eelco Dolstra <eelco.dolstra@logicblox.com> | 2009-03-03 13:47:46 +0000 |
|---|---|---|
| committer | Eelco Dolstra <eelco.dolstra@logicblox.com> | 2009-03-03 13:47:46 +0000 |
| commit | 94b0227aad1537817446074dda986b96568c701d (patch) | |
| tree | 4debdf814141a76e0800566674d3cbbaa0c3bbb0 /doc/meta.xml | |
| parent | fcad0b0a5a6563453d3793e010af8b11232f64ad (diff) | |
svn path=/nixpkgs/trunk/; revision=14311
Diffstat (limited to 'doc/meta.xml')
| -rw-r--r-- | doc/meta.xml | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/meta.xml b/doc/meta.xml index 5e53609a2368c..35308f2da950f 100644 --- a/doc/meta.xml +++ b/doc/meta.xml @@ -64,10 +64,18 @@ interpretation:</para> <varlistentry> <term><varname>description</varname></term> <listitem><para>A short (one-line) description of the package. - Don’t include a period at the end. This is shown by - <command>nix-env -q --description</command> and also on the - Nixpkgs release pages. Example: <literal>"A program that produces - a familiar, friendly greeting"</literal></para></listitem> + This is shown by <command>nix-env -q --description</command> and + also on the Nixpkgs release pages.</para> + + <para>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.</para> + + <para>Wrong: <literal>"libpng is a library that allows you to decode PNG images."</literal></para> + + <para>Right: <literal>"A library for decoding PNG images"</literal></para> + + </listitem> </varlistentry> <varlistentry> |