[Emacs-diffs] Changes to emacs/lispref/tips.texi [lexbind]

[Miles Bader]

Index: emacs/lispref/tips.texi
diff -c emacs/lispref/tips.texi:1.43.2.1 emacs/lispref/tips.texi:1.43.2.2
*** emacs/lispref/tips.texi:1.43.2.1    Fri Apr  4 01:20:42 2003
--- emacs/lispref/tips.texi     Tue Oct 14 19:10:12 2003
***************
*** 126,131 ****
--- 126,137 ----
  name that ends in @samp{-flag}.
  
  @item
+ If the purpose of a variable is to store a single function, give it a
+ name that ends in @samp{-function}.  If the purpose of a variable is
+ to store a list of functions (i.e., the variable is a hook), please
+ follow the naming conventions for hooks.  @xref{Hooks}.
+ 
+ @item
  @cindex reserved keys
  @cindex keys, reserved
  Please do not define @kbd{C-c @var{letter}} as a key in your major
***************
*** 204,210 ****
  that simply loading it has no visible effect---that should not enable
  the address@hidden that the package may be loaded
  arbitrarily by Custom for instance.}  Users will request the feature by
! invoking the command.
  
  @item
  It is a bad idea to define aliases for the Emacs primitives.  Use the
--- 210,224 ----
  that simply loading it has no visible effect---that should not enable
  the address@hidden that the package may be loaded
  arbitrarily by Custom for instance.}  Users will request the feature by
! invoking the command.  It is a good idea to define this command
! as a minor mode.
! 
! @cindex unloading packages
! If loading the file adds functions to hooks, define a function
! @address@hidden, 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}.
  
  @item
  It is a bad idea to define aliases for the Emacs primitives.  Use the
***************
*** 236,241 ****
--- 250,262 ----
  replacements differs from that of the originals.
  
  @item
+ Avoid using macros that define functions and variables with names that
+ are constructed.  It is best for maintenance wen the name of the
+ function or variable being defined is given explicitly in the source
+ code, as the second element of the list---as it is when you use
+ @code{defun}, @code{defalias}, @code{defvar} and @code{defopt}.
+ 
+ @item
  Please keep the names of your Emacs Lisp source files to 13 characters
  or less.  This way, if the files are compiled, the compiled files' names
  will be 14 characters or less, which is short enough to fit on all kinds
***************
*** 850,856 ****
  @end example
  
  @noindent
! The description should be complete in one line.
  
    After the copyright notice come several @dfn{header comment} lines,
  each beginning with @samp{;; @var{header-name}:}.  Here is a table of
--- 871,878 ----
  @end example
  
  @noindent
! The description should be complete in one line.  If the file
! needs a @samp{-*-} specification, put it after @var{description}.
  
    After the copyright notice come several @dfn{header comment} lines,
  each beginning with @samp{;; @var{header-name}:}.  Here is a table of
***************
*** 926,934 ****
  text is used by the Finder package, so it should make sense in that
  context.
  
! @item ;;; Documentation
! This has been used in some files in place of @samp{;;; Commentary:},
! but @samp{;;; Commentary:} is preferred.
  
  @item ;;; Change Log:
  This begins change log information stored in the library file (if you
--- 948,956 ----
  text is used by the Finder package, so it should make sense in that
  context.
  
! @item ;;; Documentation:
! This was used in some files in place of @samp{;;; Commentary:},
! but it is deprecated.
  
  @item ;;; Change Log:
  This begins change log information stored in the library file (if you
***************
*** 945,947 ****
--- 967,973 ----
  Its purpose is to enable people to detect truncated versions of the file
  from the lack of a footer line.
  @end table
+ 
+ @ignore
+    arch-tag: 9ea911c2-6b1d-47dd-88b7-0a94e8b27c2e
+ @end ignore