Skip to content

Commit 3b1901e

Browse files
h-eastchrisbra
authored andcommitted
runtime(doc): Tweak documentation style
closes: #18436 Signed-off-by: Hirohito Higashi <[email protected]> Signed-off-by: Christian Brabandt <[email protected]>
1 parent 5348829 commit 3b1901e

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

runtime/doc/develop.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*develop.txt* For Vim version 9.1. Last change: 2025 Sep 23
1+
*develop.txt* For Vim version 9.1. Last change: 2025 Sep 29
22

33

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

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

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

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

435435
*style-clang-format*
436436
sound.c and sign.c can be (semi-) automatically formatted using the

runtime/doc/helphelp.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*helphelp.txt* For Vim version 9.1. Last change: 2025 Sep 27
1+
*helphelp.txt* For Vim version 9.1. Last change: 2025 Sep 29
22

33

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

0 commit comments

Comments
 (0)