]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): Tweak documentation style
authorHirohito Higashi <h.east.727@gmail.com>
Mon, 29 Sep 2025 19:57:27 +0000 (19:57 +0000)
committerChristian Brabandt <cb@256bit.org>
Mon, 29 Sep 2025 19:57:27 +0000 (19:57 +0000)
closes: #18436

Signed-off-by: Hirohito Higashi <h.east.727@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
runtime/doc/develop.txt
runtime/doc/helphelp.txt

index 85bc7d7e6b69dde5ee4ec9bc5b3ca90a3ba739fb..52d07b10bead8b77aabba3f4c011ff94168ad865 100644 (file)
@@ -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 Vims 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
index ac57264b84e358a4a8e26184479b2ea4174e29ec..5b3bf6b6dd0f4779299d97fb9c3611bc6fa9a064 100644 (file)
@@ -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.