runtime(doc): Tweak documentation style a bit Commit: https://github.com/vim/vim/commit/0ed11ba223ec69dfefc8cc5800fb3e0d610fd9f8 Author: Hirohito Higashi <h.east....@gmail.com> Date: Fri Apr 18 18:45:31 2025 +0200
runtime(doc): Tweak documentation style a bit Signed-off-by: Christian Brabandt <c...@256bit.org> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c766d71d5..b15727751 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,13 +33,13 @@ terms. To sign off a commit, simply use the -s flag when committing: ```sh git commit -s -``` +``` This ensures that every contribution is properly documented and traceable, aligning with industry standards used in projects like the Linux Kernel or the git project. By making Signed-off commits a standard practice, we help maintain a legally compliant and well-governed codebase while fostering trust -within our contributor community. +within our contributor community. When merging PRs into Vim, the current maintainer @chrisbra usually adds missing `Signed-off-by` trailers for the author user name and email address as well for @@ -71,7 +71,7 @@ Or open [the todo file][todo list] on GitHub to see the latest version. # Syntax, indent and other runtime files The latest version of these files can be obtained from the repository. -They are usually not updated with numbered patches. However, they may +They are usually not updated with numbered patches. However, they may or may not work with older Vim releases (since they may contain new features). If you find a problem with one of these files or have a suggestion for diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index 4ad6b3d7d..b69f6b463 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -8158,7 +8158,7 @@ printf({fmt}, {expr1} ...) *printf()* < 1.41 You will get an overflow error |E1510|, when the field-width - or precision will result in a string longer than 1 MB + or precision will result in a string longer than 1 MiB (1024*1024 = 1048576) chars. *E1500* diff --git a/runtime/doc/version9.txt b/runtime/doc/version9.txt index 4fb322708..527ed1850 100644 --- a/runtime/doc/version9.txt +++ b/runtime/doc/version9.txt @@ -41637,8 +41637,8 @@ Options: ~ - use 'smoothscroll' logic for CTRL-F / CTRL-B for pagewise scrolling and CTRL-D / CTRL-U for half-pagewise scrolling - New option value for 'fillchars': - "trunc" - configure truncation indicator, 'pummaxwidth' - "truncrl" - like "trunc" but in 'rl' mode, 'pummaxwidth' + "trunc" - configure truncation indicator, 'pummaxwidth' + "truncrl" - like "trunc" but in 'rl' mode, 'pummaxwidth' Ex commands: ~ - allow to specify a priority when defining a new sign |:sign-define| diff --git a/runtime/doc/vim9.txt b/runtime/doc/vim9.txt index 54fb8f333..ba72358d1 100644 --- a/runtime/doc/vim9.txt +++ b/runtime/doc/vim9.txt @@ -1,4 +1,4 @@ -*vim9.txt* For Vim version 9.1. Last change: 2025 Apr 03 +*vim9.txt* For Vim version 9.1. Last change: 2025 Apr 18 VIM REFERENCE MANUAL by Bram Moolenaar @@ -1493,11 +1493,11 @@ tuple<number> a tuple with a single item of type |Number| tuple<number, string> a tuple with two items of type |Number| and |String| tuple<number, float, bool> a tuple with three items of type |Number|, - |Float| and |Boolean|. + |Float| and |Boolean| tuple<...list<number>> a variadic tuple with zero or more items of - type |Number|. + type |Number| tuple<number, ...list<string>> a tuple with an item of type |Number| followed - by zero or more items of type |String|. + by zero or more items of type |String| Examples: > var myTuple: tuple<number> = (20,) -- -- You received this message from the "vim_dev" maillist. Do not top-post! Type your reply below the text you are replying to. For more information, visit http://www.vim.org/maillist.php --- You received this message because you are subscribed to the Google Groups "vim_dev" group. To unsubscribe from this group and stop receiving emails from it, send an email to vim_dev+unsubscr...@googlegroups.com. To view this discussion visit https://groups.google.com/d/msgid/vim_dev/E1u5p4O-00AuV8-Dh%40256bit.org.