From 94b0227aad1537817446074dda986b96568c701d Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Tue, 3 Mar 2009 13:47:46 +0000 Subject: [PATCH] svn path=/nixpkgs/trunk/; revision=14311 --- doc/meta.xml | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/doc/meta.xml b/doc/meta.xml index 5e53609a2368..35308f2da950 100644 --- a/doc/meta.xml +++ b/doc/meta.xml @@ -64,10 +64,18 @@ interpretation: description A short (one-line) description of the package. - Don’t include a period at the end. This is shown by - nix-env -q --description and also on the - Nixpkgs release pages. Example: "A program that produces - a familiar, friendly greeting" + This is shown by nix-env -q --description and + also on the Nixpkgs release pages. + + 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. + + Wrong: "libpng is a library that allows you to decode PNG images." + + Right: "A library for decoding PNG images" + +