Skip to content

Commit 57eb1d4

Browse files
h-eastchrisbra
authored andcommitted
runtime(doc): Tweak documentation style
closes: #17959 Signed-off-by: Hirohito Higashi <h.east.727@gmail.com> Signed-off-by: Christian Brabandt <cb@256bit.org>
1 parent eeef7c7 commit 57eb1d4

5 files changed

Lines changed: 22 additions & 23 deletions

File tree

runtime/autoload/vimcomplete.vim

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
vim9script
22

33
# Vim completion script
4-
# Language: Vimscript
4+
# Language: Vim script
55
# Maintainer: Maxim Kim <habamax@gmail.com>
6-
# Last Change: 2025-07-28
6+
# Last Change: 2025-08-10
77
#
88
# Usage:
99
# setlocal omnifunc=vimcomplete#Complete
1010
#
11-
# Simple complete function for the Vimscript
11+
# Simple complete function for Vim script
1212

1313
var trigger: string = ""
1414
var prefix: string = ""

runtime/doc/develop.txt

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*develop.txt* For Vim version 9.1. Last change: 2025 Aug 08
1+
*develop.txt* For Vim version 9.1. Last change: 2025 Aug 10
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -308,11 +308,11 @@ Vim's main Makefiles target maximum portability, relying solely on features
308308
defined in POSIX.1-2001 `make` and ignoring later POSIX standards or GNU/BSD
309309
extensions. In practical terms, avoid:
310310

311-
% pattern rules
312-
modern assignment (`:=`, `::=`) outside POSIX.1-2001
313-
special targets (`.ONESHELL`, `.NOTPARALLEL`, `.SILENT`, )
314-
order-only prerequisites (`|`) or automatic directory creation
315-
GNU/BSD conditionals (`ifdef`, `ifndef`, `.for`/`.endfor`, )
311+
- % pattern rules
312+
- modern assignment (`:=`, `::=`) outside POSIX.1-2001
313+
- special targets (`.ONESHELL`, `.NOTPARALLEL`, `.SILENT`, ...)
314+
- order-only prerequisites (`|`) or automatic directory creation
315+
- GNU/BSD conditionals (`ifdef`, `ifndef`, `.for`/`.endfor`, ...)
316316

317317
Since POSIX.1-2001 supports only traditional suffix rules, every object built
318318
in a separate directory must have an explicit rule. For example:
@@ -339,21 +339,21 @@ Therefore, the latest ISO C standard we follow is:
339339
`C95` (ISO/IEC 9899:1990/AMD1:1995)
340340

341341
In addition, the following `C99` features are explicitly allowed:
342-
– logical lines may contain up to 4095 characters;
343-
`//` comments, as required by |style-comments|;
344-
– the `_Bool` type.
342+
- `//` comments, as required by |style-comments|;
343+
- the `_Bool` type.
344+
- logical lines may contain up to 4095 characters;
345345

346346
Platform-specific code may use any newer compiler features supported on that
347347
platform.
348348

349349

350350
SIZE OF VARIABLES *assumptions-variables*
351351

352-
We follow POSIX.12001 (SUSv3) for type sizes, which in practice means:
352+
We follow POSIX.1-2001 (SUSv3) for type sizes, which in practice means:
353353

354-
char_u 8-bit unsigned
355-
int 32-bit signed
356-
unsigned 32-bit unsigned
354+
char_u 8-bit unsigned
355+
int 32-bit or larger signed
356+
unsigned 32-bit or larger unsigned
357357

358358

359359
==============================================================================

runtime/doc/filetype.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*filetype.txt* For Vim version 9.1. Last change: 2025 Aug 06
1+
*filetype.txt* For Vim version 9.1. Last change: 2025 Aug 10
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -1072,7 +1072,7 @@ The Vim filetype plugin defines the following mappings:
10721072
]" move to the next (legacy) comment
10731073
[" move to the previous (legacy) comment
10741074
gf edit the file under the cursor
1075-
CTRL-W gf edit the file under the cursor in a new tab
1075+
CTRL-W gf edit the file under the cursor in a new tab page
10761076
CTRL-W f edit the file under the cursor in a new window
10771077

10781078

runtime/ftplugin/vim.vim

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
" Vim filetype plugin
22
" Language: Vim
33
" Maintainer: Doug Kearns <dougkearns@gmail.com>
4-
" Last Change: 2025 Aug 07
54
" Former Maintainer: Bram Moolenaar <Bram@vim.org>
65
" Contributors: Riley Bruins <ribru17@gmail.com> ('commentstring')
76
" @Konfekt
87
" @tpope (s:Help())
98
" @lacygoill
10-
" Last Change: 2025 Mar 05
9+
" Last Change: 2025 Aug 07
1110
" 2025 Aug 06 by Vim Project (add gf maps #17881)
12-
" 2025 Aug 08 by Vim Project (add vimscript complete function #17871)
11+
" 2025 Aug 08 by Vim Project (add Vim script complete function #17871)
1312

1413
" Only do this when not done yet for this buffer
1514
if exists("b:did_ftplugin")

runtime/pack/dist/opt/helptoc/doc/helptoc.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*helptoc.txt* For Vim version 9.1. Last change: 2025 Aug 06
1+
*helptoc.txt* For Vim version 9.1. Last change: 2025 Aug 10
22

33

44
VIM REFERENCE MANUAL
@@ -178,7 +178,7 @@ brackets preceding and following each heading's text.
178178

179179
3.7 vim *HelpToc-vim-filetype*
180180

181-
Vimscript and Vim9 script do not have headings or levels inherently like
181+
Vim script and Vim9 script do not have headings or levels inherently like
182182
markup languages. However, Vim provides for |folds| defined by markers (|{{{|),
183183
which themselves may be succeeded by a number explicitly indicating the fold
184184
level. This is the structure recognized and supported by helptoc.vim.

0 commit comments

Comments
 (0)