emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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


From: Richard M. Stallman
Subject: [Emacs-diffs] Changes to emacs/lispref/tips.texi
Date: Mon, 13 Oct 2003 15:29:54 -0400

Index: emacs/lispref/tips.texi
diff -c emacs/lispref/tips.texi:1.51 emacs/lispref/tips.texi:1.52
*** emacs/lispref/tips.texi:1.51        Thu Oct  9 23:02:39 2003
--- emacs/lispref/tips.texi     Mon Oct 13 15:29:53 2003
***************
*** 210,225 ****
  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, which will often be constructed as a minor mode.
  
  @cindex unloading packages
! If your package contains functions which do modify ordinary Emacs
! behavior, for instance by adding functions to hooks, define a function
! @address@hidden where @var{feature} is the name of
! the feature the package provides.  This function should undo any such
! changes, e.g.@: by turning off a minor mode, when
! @findex unload-feature
! @code{unload-feature} is used.
  
  @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
***************
*** 251,265 ****
  replacements differs from that of the originals.
  
  @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
  of Unix systems.
  
  @item
- @findex next-line
- @findex previous-line
- @findex forward-line
  Don't use @code{next-line} or @code{previous-line} in programs; nearly
  always, @code{forward-line} is more convenient as well as more
  predictable and robust.  @xref{Text Lines}.
--- 250,268 ----
  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
  of Unix systems.
  
  @item
  Don't use @code{next-line} or @code{previous-line} in programs; nearly
  always, @code{forward-line} is more convenient as well as more
  predictable and robust.  @xref{Text Lines}.
***************
*** 946,953 ****
  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
--- 949,956 ----
  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




reply via email to

[Prev in Thread] Current Thread [Next in Thread]