Commit: runtime(doc): Tweak documentation style

6 views
Skip to first unread message

Christian Brabandt

unread,
Sep 29, 2025, 4:00:17 PMSep 29
to vim...@googlegroups.com
runtime(doc): Tweak documentation style

Commit: https://github.com/vim/vim/commit/3b1901eb53ee02bd8701094f4fd6ad1bebe460e5
Author: Hirohito Higashi <h.eas...@gmail.com>
Date: Mon Sep 29 19:57:27 2025 +0000

runtime(doc): Tweak documentation style

closes: https://github.com/vim/vim/issues/18436

Signed-off-by: Hirohito Higashi <h.eas...@gmail.com>
Signed-off-by: Christian Brabandt <c...@256bit.org>

diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt
index 85bc7d7e6..52d07b10b 100644
--- a/runtime/doc/develop.txt
+++ b/runtime/doc/develop.txt
@@ -1,4 +1,4 @@
-*develop.txt* For Vim version 9.1. Last change: 2025 Sep 23
+*develop.txt* For Vim version 9.1. Last change: 2025 Sep 29


VIM REFERENCE MANUAL by Bram Moolenaar
@@ -388,7 +388,7 @@ unreliable, fails on major platforms (e.g., macOS), and is only part of the
new release workflow. In practice, contributors edit the relevant `.pro` files
by hand when adding, removing, or modifying a function signatures.

-This system has been in place since at least v1.24, when Vim’s functions were
+This system has been in place since at least v1.24, when Vim's functions were
still written in K&R style.

==============================================================================
@@ -425,12 +425,12 @@ For any non-trivial change, please always create a pull request on github,
since this triggers the test suite.

A PR should ideally contain a single commit for a single logical change.
-However, you can include several commits if you want to group multiple
-logical, atomic changes in one PR. This can also make longer PRs easier to
-review. Be sure to describe the reasoning for your changes in each commit
-message, as this greatly helps with the review process. In cases where each
-commit handles different logical changes, they will also be applied as
-separate patches in Vim’s repository.
+However, you can include several commits if you want to group multiple logical,
+atomic changes in one PR. This can also make longer PRs easier to review. Be
+sure to describe the reasoning for your changes in each commit message, as
+this greatly helps with the review process. In cases where each commit
+handles different logical changes, they will also be applied as separate
+patches in Vim's repository.

*style-clang-format*
sound.c and sign.c can be (semi-) automatically formatted using the
diff --git a/runtime/doc/helphelp.txt b/runtime/doc/helphelp.txt
index ac57264b8..5b3bf6b6d 100644
--- a/runtime/doc/helphelp.txt
+++ b/runtime/doc/helphelp.txt
@@ -1,4 +1,4 @@
-*helphelp.txt* For Vim version 9.1. Last change: 2025 Sep 27
+*helphelp.txt* For Vim version 9.1. Last change: 2025 Sep 29


VIM REFERENCE MANUAL by Bram Moolenaar
@@ -478,8 +478,8 @@ annotation (e.g. "vim") after a greater than (>) character. E.g. >vim
*g:help_example_languages*
By default, help files only support Vim script highlighting. If you need
syntax highlighting for other languages, add to your |vimrc|: >
- :let g:help_example_languages = {
- \ "vim": "vim", "vim9": "vim", "bash": "sh" }
+ :let g:help_example_languages = #{
+ \ vim: "vim", vim9: "vim", bash: "sh" }
The key represents the annotation marker name, and the value is the 'syntax'
name.

Christian Brabandt

unread,
Oct 1, 2025, 4:15:17 PMOct 1
to vim...@googlegroups.com
runtime(doc): Tweak documentation style

Commit: https://github.com/vim/vim/commit/6e282117c7409af15f33120e67a00c47eefbbba5
Author: Hirohito Higashi <h.eas...@gmail.com>
Date: Wed Oct 1 20:07:33 2025 +0000

runtime(doc): Tweak documentation style

closes: https://github.com/vim/vim/issues/18462

Signed-off-by: Hirohito Higashi <h.eas...@gmail.com>
Signed-off-by: Christian Brabandt <c...@256bit.org>

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index e644fd11d..6d2b3242d 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1,4 +1,4 @@
-*options.txt* For Vim version 9.1. Last change: 2025 Sep 29
+*options.txt* For Vim version 9.1. Last change: 2025 Oct 01


VIM REFERENCE MANUAL by Bram Moolenaar
@@ -2257,12 +2257,11 @@ A jump table for the options with a short description can be found at |Q_op|.
see 'completefuzzycollect'.

longest
- When 'autocomplete' is not active, only the longest
- common prefix of the matches is inserted. If the popup
- menu is displayed, you can use CTRL-L to add more
- characters. Whether case is ignored depends on the type
- of completion. For buffer text the 'ignorecase' option
- applies.
+ When 'autocomplete' is not active, only the longest common
+ prefix of the matches is inserted. If the popup menu is
+ displayed, you can use CTRL-L to add more characters.
+ Whether case is ignored depends on the type of completion.
+ For buffer text the 'ignorecase' option applies.

When 'autocomplete' is active and no completion item is
selected, the longest common prefix of the matches is
@@ -2313,8 +2312,8 @@ A jump table for the options with a short description can be found at |Q_op|.
{only works when compiled with the |+textprop| feature}

preinsert
- Inserts the text of the first completion candidate
- beyond the current leader, highlighted with |hl-PreInsert|.
+ Inserts the text of the first completion candidate beyond
+ the current leader, highlighted with |hl-PreInsert|.
The cursor does not move.
Requires "fuzzy" to be unset, and either "menuone" in
'completeopt' or 'autocomplete' enabled. When
diff --git a/runtime/doc/os_win32.txt b/runtime/doc/os_win32.txt
index fc3ea8439..adce877ac 100644
--- a/runtime/doc/os_win32.txt
+++ b/runtime/doc/os_win32.txt
@@ -1,4 +1,4 @@
-*os_win32.txt* For Vim version 9.1. Last change: 2025 Sep 25
+*os_win32.txt* For Vim version 9.1. Last change: 2025 Oct 01


VIM REFERENCE MANUAL by George Reilly
@@ -24,8 +24,7 @@ The 32 bit version also runs on 64 bit MS-Windows systems.
7. Installation package |win32-installer|
8. Win32 mini FAQ |win32-faq|

-Additionally, there are a number of common Win32 and DOS items in
-|os_dos.txt|:
+Additionally, there are a number of common Win32 and DOS items in |os_dos.txt|:
File locations |dos-locations|
Using backslashes |dos-backslash|
Standard mappings |dos-standard-mappings|
Reply all
Reply to author
Forward
0 new messages