emacs-devel
[Top][All Lists]
Advanced

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

Re: Docstring line length


From: Lennart Borgman
Subject: Re: Docstring line length
Date: Wed, 21 Dec 2005 22:44:50 +0100
User-agent: Mozilla Thunderbird 1.0.7 (Windows/20050923)

Drew Adams wrote:

       (In any case, many Plist entries already wrap as ugly
        continuation lines, so they need to be fixed first.)

   Could you show me an example?

By "fixed" I meant to wrap (fill) each Plist entry.


abbrev-mode
 Plist: event-symbol-element-mask event-symbol-elements modifier-cache
custom-group standard-value variable-documentation custom-type
custom-requests

Does this small patch make it more readable:


Index: apropos.el
===================================================================
RCS file: /cvsroot/emacs/emacs/lisp/apropos.el,v
retrieving revision 1.111
diff -c -r1.111 apropos.el
*** apropos.el    29 Nov 2005 23:52:59 -0000    1.111
--- apropos.el    21 Dec 2005 21:14:58 -0000
***************
*** 85,91 ****
   :group 'apropos
   :type 'face)

! (defcustom apropos-label-face 'italic
   "*Face for label (`Command', `Variable' ...) in Apropos output.
 A value of nil means don't use any special font for them, and also
 turns off mouse highlighting."
--- 85,91 ----
   :group 'apropos
   :type 'face)

! (defcustom apropos-label-face '(:underline t :foreground "blue" :slant italic)
   "*Face for label (`Command', `Variable' ...) in Apropos output.
 A value of nil means don't use any special font for them, and also
 turns off mouse highlighting."
***************
*** 976,990 ****
   (if (stringp (setq i (nth i apropos-item)))
       (progn
     (insert "  ")
!     (insert-text-button (button-type-get type 'apropos-label)
!                 'type type
!                 ;; Can't use the default button face, since
!                 ;; user may have changed the variable!
!                 ;; Just say `no' to variables containing faces!
!                 'face apropos-label-face
!                 'apropos-symbol (car apropos-item))
!     (insert ": ")
!     (insert (if do-keys (substitute-command-keys i) i))
     (or (bolp) (terpri)))))


--- 976,992 ----
   (if (stringp (setq i (nth i apropos-item)))
       (progn
     (insert "  ")
!         (let ((start (point)))
!           (insert-text-button (button-type-get type 'apropos-label)
!                               'type type
!                               ;; Can't use the default button face, since
!                               ;; user may have changed the variable!
! ;; Just say `no' to variables containing faces!
!                               'face apropos-label-face
!                               'apropos-symbol (car apropos-item))
!           (insert ": ")
!           (insert (if do-keys (substitute-command-keys i) i))
!           (fill-region start (point)))
     (or (bolp) (terpri)))))





reply via email to

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