bug#16025: 24.3.50; doc string of `insert-kbd-macro'

bug#16025: 24.3.50; doc string of `insert-kbd-macro'

[Drew Adams]

Doc string:

 (insert-kbd-macro MACRONAME &optional KEYS)

 Insert in buffer the definition of kbd macro NAME, as Lisp code.

1. Uh, no.  Choose one or the other: MACRONAME or NAME.

2. Say what NAME/MACRONAME is: a symbol.  NAME as an argument in Emacs
often means a string, and anyway, a Lisp user won't know which you mean.

Consider calling it SYMBOL:

 (insert-kbd-macro SYMBOL &optional KEYS)

 Insert the definition of the kbd macro named SYMBOL, as Lisp code.

This would also be in keeping with `name-last-kbd-macro' and
`kmacro-name-last-macro':

 (name-last-kbd-macro SYMBOL)

 Assign a name to the last keyboard macro defined.
 Argument SYMBOL is the name to define.

 (kmacro-name-last-macro SYMBOL)

 Assign a name to the last keyboard macro defined.
 Argument SYMBOL is the name to define.




In GNU Emacs 24.3.50.2 (i686-pc-mingw32)
 of 2013-11-28 on LEG570
Bzr revision: 115271 rgm@gnu.org-20131128203155-qjc1xsp19z2k64b2
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking 'CFLAGS=-O0 -g3' CPPFLAGS=-DGLYPH_DEBUG=1'

bug#16025: 24.3.50; doc string of `insert-kbd-macro'

[Lars Ingebrigtsen]

Drew Adams <drew.adams@oracle.com> writes:

> Doc string:
>
>  (insert-kbd-macro MACRONAME &optional KEYS)
>
>  Insert in buffer the definition of kbd macro NAME, as Lisp code.
>
> 1. Uh, no.  Choose one or the other: MACRONAME or NAME.
>
> 2. Say what NAME/MACRONAME is: a symbol.  NAME as an argument in Emacs
> often means a string, and anyway, a Lisp user won't know which you mean.

Fixed on trunk.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/