diff man/xemacs/packages.texi @ 1613:138c42c84aec

[xemacs-hg @ 2003-08-11 10:07:09 by stephent] package style guide <874r0oh5lo.fsf@tleepslib.sk.tsukuba.ac.jp>
author stephent
date Mon, 11 Aug 2003 10:07:12 +0000
parents eaba5c93c383
children 712931b4b71d
line wrap: on
line diff
--- a/man/xemacs/packages.texi	Mon Aug 11 10:03:36 2003 +0000
+++ b/man/xemacs/packages.texi	Mon Aug 11 10:07:12 2003 +0000
@@ -575,7 +575,7 @@
    priority high
    category CATEGORY
    dump nil
-   description "description"        ; a one-line description string
+   description "DESCRIPTION"        ; one-line period-terminated string
    filename FILENAME
    md5sum MD5SUM
    size SIZE
@@ -590,11 +590,13 @@
 of the main Lisp file or principal feature provided.  The allowed values
 for distribution are @code{xemacs} and @code{mule}.  Write them as
 unquoted symbols.  The @code{description} is a quoted Lisp string; use
-the usual conventions.  The value for @code{provides} is a list of
-feature symbols (written unquoted).  All of the features provided by
-libraries in your package should be elements of this list.  Implementing
-an automatic method for generating the @file{provides} line is
-desirable, but as yet undone.
+the usual conventions.  The first letter should be capitalized, and the
+string should end in a period.  It need not be a complete sentence
+grammatically.  The value for @code{provides} is a list of feature
+symbols (written unquoted).  All of the features provided by libraries
+in your package should be elements of this list.  Implementing an
+automatic method for generating the @file{provides} line is desirable,
+but as yet undone.
 
 The variables in upper-case are references to variables set in the
 @file{Makefile} or automatically generated.  Do not change them; they