Doc fixes.

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Doc fixes.

Luc Teirlinck
What about the following patch which brings the lengths of three first
lines of docstrings below the maximum allowed 67 characters?  If it
exceeds that number, it not only looks bad in appropos, but when the
variable is defined with a defcustom, it looks terrible in Custom
buffers.  For the three variables in question, the docstrings start
looking really bad in the Lisp Custom group when one ckicks on "More"
to read the entire docstring.

I can install if desired.

===File ~/simple.el-diff====================================
*** simple.el 03 Jun 2005 18:43:57 -0500 1.724
--- simple.el 03 Jun 2005 20:46:58 -0500
***************
*** 920,940 ****
  (defvar read-expression-history nil)
 
  (defcustom eval-expression-print-level 4
!   "*Value to use for `print-level' when printing value in `eval-expression'.
  A value of nil means no limit."
    :group 'lisp
    :type '(choice (const :tag "No Limit" nil) integer)
    :version "21.1")
 
  (defcustom eval-expression-print-length 12
!   "*Value to use for `print-length' when printing value in `eval-expression'.
  A value of nil means no limit."
    :group 'lisp
    :type '(choice (const :tag "No Limit" nil) integer)
    :version "21.1")
 
  (defcustom eval-expression-debug-on-error t
!   "*Non-nil means set `debug-on-error' when evaluating in `eval-expression'.
  If nil, don't change the value of `debug-on-error'."
    :group 'lisp
    :type 'boolean
--- 920,940 ----
  (defvar read-expression-history nil)
 
  (defcustom eval-expression-print-level 4
!   "Value of `print-level' while printing value in `eval-expression'.
  A value of nil means no limit."
    :group 'lisp
    :type '(choice (const :tag "No Limit" nil) integer)
    :version "21.1")
 
  (defcustom eval-expression-print-length 12
!   "Value of `print-length' while printing value in `eval-expression'.
  A value of nil means no limit."
    :group 'lisp
    :type '(choice (const :tag "No Limit" nil) integer)
    :version "21.1")
 
  (defcustom eval-expression-debug-on-error t
!   "If non-nil set `debug-on-error' to t in `eval-expression'.
  If nil, don't change the value of `debug-on-error'."
    :group 'lisp
    :type 'boolean
============================================================


_______________________________________________
Emacs-devel mailing list
[hidden email]
http://lists.gnu.org/mailman/listinfo/emacs-devel
Reply | Threaded
Open this post in threaded view
|

Re: Doc fixes.

Richard Stallman
These changes are good, but please write "Value for" instead of
"Value of".


_______________________________________________
Emacs-devel mailing list
[hidden email]
http://lists.gnu.org/mailman/listinfo/emacs-devel