Skip to content

runtime(doc): Use Ex command highlighting at :help ex-cmd-index - #18620

Draft
dkearns wants to merge 1 commit into
vim:masterfrom
dkearns:runtime-doc-use-ex-command-highlighting-at-help-ex-cmd-index
Draft

dkearns wants to merge 1 commit into
vim:masterfrom
dkearns:runtime-doc-use-ex-command-highlighting-at-help-ex-cmd-index

Conversation

@dkearns

@dkearns dkearns commented Oct 22, 2025

Copy link
Copy Markdown
Contributor

Ex command markup was introduced in commit d38b055 (26/4/12) but it appears that it was never comprehensively applied to the help files. The majority of Ex command references are still highlighted as links.

See :help help-writing (TAGS section).

@dkearns

dkearns commented Oct 22, 2025

Copy link
Copy Markdown
Contributor Author

@zeertzjq, @h-east, @chrisbra if I understand the situation correctly then all Ex commands using |:edit| should be converted to `:edit`?

I can't say I'm too keen on the Comment highlighting. It makes sense for the example code, which it's trying to match, but in general descriptive text it encourages me to ignore the command name text rather than take extra note of it.

@dkearns
dkearns force-pushed the runtime-doc-use-ex-command-highlighting-at-help-ex-cmd-index branch from 9edceee to b6aad5a Compare October 22, 2025 06:51
@h-east

h-east commented Oct 22, 2025

Copy link
Copy Markdown
Contributor

JFYI, I’m not sure if this will be helpful, but here’s the response I received when I asked Bram before.
#10620 (comment)

Ex command markup was introduced in commit d38b055 (26/4/12) but it
appears that it was never comprehensively applied to the help files.
The majority of Ex command references are still highlighted as links.

See :help help-writing (TAGS section).

Signed-off-by: Doug Kearns <dougkearns@gmail.com>
@dkearns
dkearns force-pushed the runtime-doc-use-ex-command-highlighting-at-help-ex-cmd-index branch from b6aad5a to 5191b01 Compare October 2, 2026 04:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants