Prompt text suggestions (and some for command names)

[hmelman]

Reading through consult a few of the prompt texts struck me as a litle off. I made a pass through the commands and have some suggestions to improve them. This is all minor stuff.

First the simple ones, just the changing the prompt text.

1. Imenu.el commands refer to "index item"s so I think consult-imenu should prompt "Go to index item: "

2. consult--yank-read just prompts with "Ring: " which is a little obtuse, I think "Yank text: " is clearer.

3. consult-line was one of the first that seemed off to me. It prompts now with "Go to line: " and at first I was thinking it was asking for a line number. "Go to line containing: " is clearer, but doesn't match with other things. I'm not completely satisfied with this suggestion, and as it stands it's consistent with other prompts, but I think it needs something because lines are so typically described by their number.

These I suggest changing the command name as well.

4. consult-minor-mode-menu should just be consult-minor-mode the way consult-theme doesn't have "-menu" appended.

5. consult-outline currently prompts with "Go to heading: ". I think the command name should match the prompt and "heading" is more accurate. Outline mode commands say "heading" but of course they also begin with "outline". I think using both is best. If not, I think both the command name and prompt should use the same term and I prefer heading over outline since that what the list of candidates is. So consult-outline-heading prompting as "Go to outline heading: "

[minad]

I have to think about it. I also would like to have short prompts.

consult-minor-mode-menu should just be consult-minor-mode the way consult-theme doesn't have "-menu" appended.

No, I had that originally and this is confusing since commands ending in minor-mode are minor modes. Note that there is also the mouse-minor-mode-menu. If you have a better name please let me know, but consult-minor-mode is not possible.

consult-outline-heading

I think that name is too long.

So probably I won't change the command names but the prompts could be improved.

[hmelman]

No, I had that originally and this is confusing since commands ending in minor-mode are minor modes. Note that there is also the mouse-minor-mode-menu. If you have a better name please let me know, but consult-minor-mode is not possible.

Good point.

[oantolin]

How about the name consult-toggle-minor-mode?

[oantolin]

Or, if that still sounds like it's a minor mode, maybe consult-minor-mode-toggle. That doesn't end in minor-mode anymore. And it seems more descriptive than menu.

[minad]

Toggle is even longer than menu, and this is what we do - we consult the menu. Not the toggle.

[oantolin]

Ah! The name didn't click with me until you said "we consult the menu". Somehow I hadn't seen how that command fit the consult-thing pattern and the menu just made no sense to me. 😆

[minad]

I close this since I am mostly satisfied by the current prompts/commands. Please let me know if you have further suggestions!