+When calling FNAME if the optional parameters X-FUNCTION, X-CHAR
+and X-DESCRIPTION to the defined function FNAME are given they
+must all be given. In this case the the sequence
+`%X-DESCRIPTION%' in HELP-TEXT is replaced with the parameters
+X-CHAR character and the X-DESCRIPTION string. Also the keyboard
+character X-CHAR is bound to the parameter X-FUNCTION.
I don't understand that text; I am simply lost. You need to state
it more clearly.
The best place for this info is in the doc string of the constructed
function that will take these arguments. Moving the text there will
help you simplify the text. However, part of the reason this is
confusing is that the explanation states the algorithm for USING these
arguments. What it needs to say is WHAT THEY MEAN. Documentation
should not read like a program logic manual.
+ (mapc (lambda (elt)
+ (let ((new (if (consp elt) (cdr elt) elt))
+ (orig (if (consp elt) (car elt) elt)))
+ (mapc (lambda (key)
+ (define-key still-map key new))
+ (where-is-internal orig))))
+ still-lst)
That code needs a comment to explain what it is doing.
_______________________________________________
Emacs-devel mailing list
Emacs-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-devel
