A possible improvement might be to just list the accepted values:
(defcustom winum-scope 'global
"Frames affected by a number set.
The accepted values are:
'frame-local
'visible
'global"
Or they could also include explanations, maybe something like this:
(defcustom winum-scope 'global
"Frames affected by a number set.
The accepted values are:
'frame-local
window numbers start counting from 1 in each frame:
frame 1: 1, 2, ...
frame 2: 1, 2, ...
'visible
window numbers count from the newest frame to the oldest:
frame 1: (frame 2 last window) + 1, (frame 2 last window) + 2, ...
frame 2: 1, 2, ...
'global
window numbers count from the oldest frame to the newest:
frame 1: 1, 2, ...
frame 2: (frame 1 last window) + 1, (frame 1 last window) + 2, ..."
I noticed that the
winum-scope
variable doesn't show the accepted values in the docstring.https://github.com/deb0ch/emacs-winum/blob/c5455e866e8a5f7eab6a7263e2057aff5f1118b9/winum.el#L54-L60
A possible improvement might be to just list the accepted values:
Or they could also include explanations, maybe something like this: