~ruther/guix-local

762e54b7b476982c007c9da96b3b17476a6f1d93 — Ludovic Courtès 9 years ago 1ccb319
doc: Recommend against marketing phrases in descriptions.

* doc/guix.texi (Synopses and Descriptions): Add note about marketing
phrases.
1 files changed, 7 insertions(+), 1 deletions(-)

M doc/guix.texi
M doc/guix.texi => doc/guix.texi +7 -1
@@ 11172,9 11172,15 @@ something like ``Manipulate nucleotide sequence alignments'', which
hopefully gives the user a better idea of whether this is what they are
looking for.

@cindex Texinfo markup, in package descriptions
Descriptions should take between five and ten lines.  Use full
sentences, and avoid using acronyms without first introducing them.
Please avoid marketing phrases such as ``world-leading'',
``industrial-strength'', and ``next-generation'', and avoid superlatives
like ``the most advanced''---they are not helpful to users looking for a
package and may even sound suspicious.  Instead, try to be factual,
mentioning use cases and features.

@cindex Texinfo markup, in package descriptions
Descriptions can include Texinfo markup, which is useful to introduce
ornaments such as @code{@@code} or @code{@@dfn}, bullet lists, or
hyperlinks (@pxref{Overview,,, texinfo, GNU Texinfo}).  However you