diff options
Diffstat (limited to 'doc/lispref/tips.texi')
| -rw-r--r-- | doc/lispref/tips.texi | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi index 4a7793a976d..8aa225a00c3 100644 --- a/doc/lispref/tips.texi +++ b/doc/lispref/tips.texi @@ -75,8 +75,8 @@ example, it is our convention to have commands that list objects named as @samp{list-@var{something}}, e.g., a package called @samp{frob} could have a command @samp{list-frobs}, when its other global symbols begin with @samp{frob-}. Also, constructs that define functions, -variables, etc., work better if they start with @samp{defun} or -@samp{defvar}, so put the name prefix later on in the name. +variables, etc., work better if they start with @samp{define-}, so put +the name prefix later on in the name. This recommendation applies even to names for traditional Lisp primitives that are not primitives in Emacs Lisp---such as @@ -168,11 +168,12 @@ follow the naming conventions for hooks. @xref{Hooks}. @item @cindex unloading packages, preparing for -If loading the file adds functions to hooks, define a function -@code{@var{feature}-unload-function}, where @var{feature} is the name -of the feature the package provides, and make it undo any such -changes. Using @code{unload-feature} to unload the file will run this -function. @xref{Unloading}. +Using @code{unload-feature} will undo the changes usually done by +loading a feature (like adding functions to hooks). However, if +loading @var{feature} does something unusual and more complex, you can +define a function named @code{@var{feature}-unload-function}, and make +it undo any such special changes. @code{unload-feature} will then +automatically run this function if it exists. @xref{Unloading}. @item It is a bad idea to define aliases for the Emacs primitives. Normally @@ -1034,7 +1035,7 @@ the conventional possibilities for @var{header-name}: @table @samp @item Author -This line states the name and email address of at least the principal +This header states the name and email address of at least the principal author of the library. If there are multiple authors, list them on continuation lines led by @code{;;} and a tab or at least two spaces. We recommend including a contact email address, of the form @@ -1053,8 +1054,8 @@ This header has the same format as the Author header. It lists the person(s) who currently maintain(s) the file (respond to bug reports, etc.). -If there is no maintainer line, the person(s) in the Author field -is/are presumed to be the maintainers. Some files in Emacs use +If there is no Maintainer header, the person(s) in the Author header +is/are presumed to be the maintainer(s). Some files in Emacs use @samp{emacs-devel@@gnu.org} for the maintainer, which means the author is no longer responsible for the file, and that it is maintained as part of Emacs. |