The :universal-prefix-arg jack-in registry key introduced in #3834 is likely to confuse users, since universal-argument in Emacs is a widely understood term of art referring to '(4), '(16), etc. values (bare C-u), whereas it is used here to refer to plain integer prefix-arguments to the cider-jack-in-universal command (M-1 / C-u 1).
|
- :universal-prefix-arg numeric prefix arg for `cider-jack-in-universal'. |
A user attempting to customize cider-jack-in-tools (or someone like myself reading the source) may naturally misread the key as having something to do with C-u before discovering it's just a numeric dispatch slot.
Suggestion
Revert to the original :prefix-arg key name, or some other alternative eg. :dispatch-arg / :index that does not clash with existing terminology?
More drastic: switch up the naming scheme altogether for cider-jack-in-universal itself, keeping it as a deprecated alias? Although from the discussion in #3300 it seemed like a deliberate naming choice, so perhaps not (just noting the possibility)
Checking the docs, up_and_running.adoc displays this ambiguity to a minor degree - the term 'universal' is used in both senses within the same page:
Note that the universal argument C-u can be used before a command to override these settings
The
:universal-prefix-argjack-in registry key introduced in #3834 is likely to confuse users, sinceuniversal-argumentin Emacs is a widely understood term of art referring to '(4), '(16), etc. values (bareC-u), whereas it is used here to refer to plain integer prefix-arguments to thecider-jack-in-universalcommand (M-1/C-u 1).cider/lisp/cider-jack-in.el
Line 747 in 84800ca
A user attempting to customize
cider-jack-in-tools(or someone like myself reading the source) may naturally misread the key as having something to do withC-ubefore discovering it's just a numeric dispatch slot.Suggestion
Revert to the original
:prefix-argkey name, or some other alternative eg.:dispatch-arg/:indexthat does not clash with existing terminology?More drastic: switch up the naming scheme altogether for
cider-jack-in-universalitself, keeping it as a deprecated alias? Although from the discussion in #3300 it seemed like a deliberate naming choice, so perhaps not (just noting the possibility)Checking the docs,
up_and_running.adocdisplays this ambiguity to a minor degree - the term 'universal' is used in both senses within the same page: