Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

winum-scope docstring, list accepted values #24

Open
duianto opened this issue Nov 15, 2019 · 0 comments
Open

winum-scope docstring, list accepted values #24

duianto opened this issue Nov 15, 2019 · 0 comments

Comments

@duianto
Copy link

duianto commented Nov 15, 2019

I noticed that the winum-scope variable doesn't show the accepted values in the docstring.

winum-scope is a variable defined in ‘winum.el’.
Its value is ‘global’

Documentation:
Frames affected by a number set.

You can customize this variable.

emacs-winum/winum.el

Lines 54 to 60 in c5455e8

(defcustom winum-scope 'global
"Frames affected by a number set."
:group 'winum
:type '(choice
(const :tag "frame local" frame-local)
(const :tag "visible frames" visible)
(const :tag "global" global)))

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, ..."
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant