general.el icon indicating copy to clipboard operation
general.el copied to clipboard

`general-create-definer` generates code which puts a docstring after a `declare` clause

Open rvs314 opened this issue 7 months ago • 0 comments

I currently have the following general-create-definer invocation in my .emacs:

(general-create-definer define-global-keys
  :states '(normal insert motion visual emacs)
  :prefix "SPC"
  :keymaps 'override
  :non-normal-prefix "M-SPC")

This generates the following code:

(defmacro define-global-keys (&rest args)                                                                                                                                 
  (declare (indent defun))                                                                                                                                                
  "A wrapper for `general-def'.\n\nIt has the following defaults:\n(:states '(normal insert motion visual emacs) :prefix SPC :keymaps 'override :non-normal-prefix M-SPC)"
  `(,'general-def ,@args                                                                                                                                                  
     ,@'(:states '(normal insert motion visual emacs)                                                                                                                     
         :prefix "SPC"                                                                                                                                                    
         :keymaps 'override                                                                                                                                               
         :non-normal-prefix "M-SPC")))

The generated code seems to cause the compiler warning: "Doc string after declare". Is there a reason for this to be the case? If not, it seems like a relatively simple fix (I'd be happy to send a PR).

rvs314 avatar Jun 10 '25 17:06 rvs314