mirror of
https://github.com/vim/vim.git
synced 2025-10-16 07:24:23 -04:00
runtime(doc): Tweak documentation style
closes: #18436 Signed-off-by: Hirohito Higashi <h.east.727@gmail.com> Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
committed by
Christian Brabandt
parent
5348829784
commit
3b1901eb53
@@ -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
|
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
|
new release workflow. In practice, contributors edit the relevant `.pro` files
|
||||||
by hand when adding, removing, or modifying a function signatures.
|
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.
|
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.
|
since this triggers the test suite.
|
||||||
|
|
||||||
A PR should ideally contain a single commit for a single logical change.
|
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
|
However, you can include several commits if you want to group multiple logical,
|
||||||
logical, atomic changes in one PR. This can also make longer PRs easier to
|
atomic changes in one PR. This can also make longer PRs easier to review. Be
|
||||||
review. Be sure to describe the reasoning for your changes in each commit
|
sure to describe the reasoning for your changes in each commit message, as
|
||||||
message, as this greatly helps with the review process. In cases where each
|
this greatly helps with the review process. In cases where each commit
|
||||||
commit handles different logical changes, they will also be applied as
|
handles different logical changes, they will also be applied as separate
|
||||||
separate patches in Vim’s repository.
|
patches in Vim's repository.
|
||||||
|
|
||||||
*style-clang-format*
|
*style-clang-format*
|
||||||
sound.c and sign.c can be (semi-) automatically formatted using the
|
sound.c and sign.c can be (semi-) automatically formatted using the
|
||||||
|
@@ -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
|
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*
|
*g:help_example_languages*
|
||||||
By default, help files only support Vim script highlighting. If you need
|
By default, help files only support Vim script highlighting. If you need
|
||||||
syntax highlighting for other languages, add to your |vimrc|: >
|
syntax highlighting for other languages, add to your |vimrc|: >
|
||||||
:let g:help_example_languages = {
|
:let g:help_example_languages = #{
|
||||||
\ "vim": "vim", "vim9": "vim", "bash": "sh" }
|
\ vim: "vim", vim9: "vim", bash: "sh" }
|
||||||
The key represents the annotation marker name, and the value is the 'syntax'
|
The key represents the annotation marker name, and the value is the 'syntax'
|
||||||
name.
|
name.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user