GNU bug report logs - #12346
24.2.50; doc of `set-temporary-overlay-map'

Previous Next

Package: emacs;

Reported by: "Drew Adams" <drew.adams <at> oracle.com>

Date: Tue, 4 Sep 2012 02:59:01 UTC

Severity: minor

Merged with 11818

Found in versions 24.1.50, 24.2.50

Done: Glenn Morris <rgm <at> gnu.org>

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: Bastien <bzg <at> altern.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 12346 <at> debbugs.gnu.org
Subject: bug#12346: 24.2.50; doc of `set-temporary-overlay-map'
Date: Tue, 11 Sep 2012 18:47:42 +0200

"Drew Adams" <drew.adams <at> oracle.com> writes:

> Standard source code is being converted to use this function.  And
> 3rd-party code is starting to use it.  It has no doc string and is not
> mentioned in the Elisp manual.  Please document it.

I added this docstring:

  "Set MAP as a temporary overlay map.
When KEEP-PRED is `t', using a key from the temporary keymap
leaves this keymap activated.  KEEP-PRED can also be a function,
which will have the same effect when it returns `t'.
When KEEP-PRED is nil, the temporary keymap is used only once."

I'm not closing this bug as I didn't update the manual, 
I'm not sure where such documentation should go.

-- 
 Bastien
This bug report was last modified 12 years and 253 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.