[vim/vim] Tweak some documentation style (PR #20540)

2 views

Skip to first unread message

h_east

unread,

Jun 16, 2026, 4:19:38 PM (2 days ago) Jun 16

to vim/vim, Subscribed

builtin.txt
popup.txt

Correcting line breaks (making effective use of 78 columns)

filetype.txt (in BEANCOUNT section)

Remove help tags from variable names (since they are in the same section, they can easily be found with # or *).
Move the sample highlight closing tag (<) to the previous line.
Add a description for g:beancount_account_completion.
Remove the blank line before "Default value:".
Fix lines exceeding 80 columns. (See Note)
Adhere to the rule of using two spaces after a period at the end of a sentence. (See Note)

related: #20373
(Cc: @ambroisie @nathangrigg)

Note

Please see :h help-writing.

(snip)
STYLE
(snip)

Vim help files should be formatted for a 'textwidth' of 78 characters (with
'conceal' enabled), so they look good in a typical 80 x 24 terminal window;
use `:set colorcolumn=+0` as a visual guide.

Use two spaces between the final dot of a sentence of the first letter of the
next sentence.  Like this.

You can view, comment on, or merge this pull request online at:

https://github.com/vim/vim/pull/20540

Commit Summary

8cf4477 Tweak some documentation style

File Changes

(3 files)

Patch Links:

—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.

Christian Brabandt

unread,

Jun 17, 2026, 4:01:29 PM (9 hours ago) Jun 17

to vim/vim, Subscribed

chrisbra left a comment (vim/vim#20540)

thanks

You are receiving this because you are subscribed to this thread.

Reply all

Reply to author

Forward

0 new messages