From: Lennart Borgman <lennart.borgman.073@student.lu.se>
Cc: emacs-devel@gnu.org
Subject: Re: Suggestions for the temporary windows used from the minibuffer
Date: Tue, 09 Aug 2005 18:42:44 +0200 [thread overview]
Message-ID: <42F8DD04.30501@student.lu.se> (raw)
In-Reply-To: <E1E2Vsy-0005Rk-VL@fencepost.gnu.org>
Richard M. Stallman wrote:
> +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.
>
>
The help text is for the macro make-help-screen. The text is just meant
for the developers who wants to use this macro. The constructed function
currently has a help string that just says "Help command" and I have not
changed that. Putting the help text above in the constructed function
would make it invisible to the developer if he/she does not read the
code of make-help-screen. The users have no use for this help text.
This is for use with help in isearch mode. It adds the text
X-DESCRIPTION to the text that is normally shown when you type C-h. It
also binds the character X-CHAR to the function X-FUNCTION in keymap
used in C-h help. This is only done for isearch, otherwise the new
optional arguments X-FUNCTION, X-CHAR and X-DESCRIPTION are not used.
Maybe it would help to say "See isearch mode for an example"?
>
>+ (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.
>
>
There is a comment right over still-map (though it is short). I can add
some more comment here of course, like ";; Copy the keys from the users
current key bindings that still should be available (ie keyboard
scrolling with Page Up/Down)".
next prev parent reply other threads:[~2005-08-09 16:42 UTC|newest]
Thread overview: 107+ messages / expand[flat|nested] mbox.gz Atom feed top
2005-08-05 11:16 Suggestions for the temporary windows used from the minibuffer Lennart Borgman
2005-08-05 14:59 ` Drew Adams
2005-08-06 18:36 ` Richard M. Stallman
2005-08-07 2:20 ` Drew Adams
2005-08-08 12:09 ` Richard M. Stallman
2005-08-05 20:38 ` Richard M. Stallman
2005-08-05 23:18 ` Lennart Borgman
2005-08-06 18:35 ` Richard M. Stallman
2005-08-06 18:50 ` Lennart Borgman
2005-08-09 0:27 ` Richard M. Stallman
2005-08-09 5:13 ` Jan D.
2005-08-09 21:46 ` Richard M. Stallman
2005-08-10 14:47 ` Jan D.
2005-08-10 19:52 ` Richard M. Stallman
2005-08-10 20:05 ` David Kastrup
2005-08-10 21:51 ` Lennart Borgman
2005-08-11 14:03 ` Lennart Borgman
2005-08-11 20:42 ` Richard M. Stallman
2005-08-11 22:28 ` Lennart Borgman
2005-08-11 23:03 ` David Kastrup
2005-08-11 23:39 ` Lennart Borgman
2005-08-12 6:53 ` Frank Schmitt
2005-08-13 6:14 ` Emacs icons Juri Linkov
2005-08-12 19:58 ` Suggestions for the temporary windows used from the minibuffer Richard M. Stallman
2005-08-12 20:38 ` Lennart Borgman
2005-08-13 21:54 ` Richard M. Stallman
2005-08-10 20:01 ` Frank Schmitt
2005-08-10 20:16 ` David Kastrup
2005-08-10 21:02 ` Frank Schmitt
2005-08-10 21:19 ` David Kastrup
2005-08-10 22:01 ` Emacs icons (was: Suggestions for the temporary windows used from the minibuffer) Drew Adams
2005-08-11 20:40 ` Richard M. Stallman
2005-08-11 22:56 ` Emacs icons (was: Suggestions for the temporary windows usedfrom " Drew Adams
2005-08-12 19:57 ` Richard M. Stallman
2005-08-12 20:33 ` Emacs icons (was: Suggestions for the temporary windowsusedfrom " Drew Adams
2005-08-14 3:08 ` Emacs icons Esben Stien
2005-08-14 9:59 ` Lennart Borgman
2005-09-03 2:41 ` Esben Stien
2005-08-14 20:52 ` Lennart Borgman
2005-08-15 16:04 ` Richard M. Stallman
2005-08-15 16:59 ` David Ponce
2005-08-15 23:26 ` Lennart Borgman
2005-08-16 2:25 ` Richard M. Stallman
2005-08-16 4:23 ` Drew Adams
2005-08-16 12:02 ` Lennart Borgman
2005-08-16 13:01 ` Frank Schmitt
2005-08-16 20:43 ` Richard M. Stallman
2005-08-17 12:26 ` Werner LEMBERG
2005-08-17 15:19 ` Gian Uberto Lauri
2005-08-17 15:53 ` Lennart Borgman
2005-08-18 14:47 ` Richard M. Stallman
2005-08-18 15:04 ` Lennart Borgman
2005-08-18 17:21 ` Gian Uberto Lauri
2005-08-18 20:21 ` Frank Schmitt
2005-08-18 21:12 ` Lennart Borgman
2005-08-18 21:26 ` Frank Schmitt
2005-08-18 22:11 ` Lennart Borgman
2005-08-19 18:36 ` Frank Schmitt
2005-08-19 23:08 ` Richard M. Stallman
2005-08-19 23:25 ` Karl Chen
2005-08-20 0:42 ` Lennart Borgman
2005-08-21 5:42 ` Richard M. Stallman
2005-08-23 16:27 ` David Ponce
2005-08-24 10:32 ` Richard M. Stallman
2005-08-24 12:17 ` Ralf Angeli
2005-08-24 13:33 ` Juanma Barranquero
2005-08-24 16:09 ` Thien-Thi Nguyen
2005-08-25 10:43 ` Richard M. Stallman
2005-08-25 11:02 ` Ralf Angeli
2005-08-24 16:03 ` Drew Adams
2005-08-16 13:42 ` Lennart Borgman
2005-08-16 14:32 ` Drew Adams
2005-08-16 22:17 ` Richard M. Stallman
2005-08-17 7:16 ` David Ponce
2005-08-17 8:01 ` [OT] " Masatake YAMATO
2005-08-17 9:00 ` Lennart Borgman
2005-08-18 14:48 ` Richard M. Stallman
2005-08-18 15:17 ` Lennart Borgman
2005-08-19 16:14 ` Richard M. Stallman
2005-08-17 11:04 ` Emilio Lopes
2005-08-18 6:11 ` Stefan Reichör
2005-08-18 19:47 ` Emilio Lopes
2005-08-18 22:55 ` Drew Adams
2005-08-18 14:47 ` Richard M. Stallman
2005-08-09 5:19 ` Suggestions for the temporary windows used from the minibuffer Eli Zaretskii
2005-08-09 21:46 ` Richard M. Stallman
2005-08-10 3:43 ` Eli Zaretskii
2005-08-05 23:18 ` Lennart Borgman
2005-08-06 18:35 ` Richard M. Stallman
2005-08-06 23:02 ` Lennart Borgman
2005-08-06 23:03 ` Lennart Borgman
2005-08-08 12:09 ` Richard M. Stallman
2005-08-08 13:19 ` Lennart Borgman
2005-08-09 15:18 ` Richard M. Stallman
2005-08-07 22:30 ` Lennart Borgman
2005-08-09 15:19 ` Richard M. Stallman
2005-08-09 16:42 ` Lennart Borgman [this message]
2005-08-09 19:57 ` Lennart Borgman
2005-08-09 23:18 ` Lennart Borgman
2005-08-11 14:28 ` Richard M. Stallman
2005-08-12 1:57 ` Michael Welsh Duggan
2005-08-12 13:33 ` Drew Adams
2005-08-12 20:19 ` Lennart Borgman
2005-08-12 19:57 ` Richard M. Stallman
2005-08-11 14:28 ` Richard M. Stallman
2005-08-09 15:19 ` Richard M. Stallman
2005-08-09 16:24 ` Lennart Borgman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=42F8DD04.30501@student.lu.se \
--to=lennart.borgman.073@student.lu.se \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).