Skip to content

Commit 5711d76

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

3 files changed

Lines changed: 19 additions & 20 deletions

File tree

runtime/doc/builtin.txt

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

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -12344,7 +12344,7 @@ wildtrigger() *wildtrigger()*
1234412344
produce a beep when no matches are found and generally
1234512345
operates more quietly. This makes it suitable for triggering
1234612346
completion automatically, such as from an |:autocmd|.
12347-
*cmdline-autocompletion*
12347+
*cmdline-autocompletion*
1234812348
Example: To make the completion menu pop up automatically as
1234912349
you type on the command line, use: >
1235012350
autocmd CmdlineChanged [:/?] call wildtrigger()

runtime/doc/develop.txt

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*develop.txt* For Vim version 9.1. Last change: 2025 Jul 21
1+
*develop.txt* For Vim version 9.1. Last change: 2025 Jul 22
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -297,36 +297,35 @@ count.
297297
==============================================================================
298298
3. Assumptions *design-assumptions*
299299

300-
The following sections define the portability and compatibility constraints that
301-
all Vim code and build tools must adhere to.
300+
The following sections define the portability and compatibility constraints
301+
that all Vim code and build tools must adhere to.
302302

303303

304304
MAKEFILES *assumptions-makefiles*
305305
*POSIX.1-2001*
306306

307-
Vims main Makefiles target maximum portability, relying solely on features
308-
defined in POSIX.1-2001 `make` and ignoring later POSIX standards or
309-
GNU/BSD extensions. In practical terms, avoid:
307+
Vim's main Makefiles target maximum portability, relying solely on features
308+
defined in POSIX.1-2001 `make` and ignoring later POSIX standards or GNU/BSD
309+
extensions. In practical terms, avoid:
310310

311311
– % pattern rules
312312
– modern assignment (`:=`, `::=`) outside POSIX.1-2001
313313
– special targets (`.ONESHELL`, `.NOTPARALLEL`, `.SILENT`, …)
314314
– order-only prerequisites (`|`) or automatic directory creation
315315
– GNU/BSD conditionals (`ifdef`, `ifndef`, `.for`/`.endfor`, …)
316316

317-
Since POSIX.1-2001 supports only traditional suffix rules, every object
318-
built in a separate directory must have an explicit rule. For example:
317+
Since POSIX.1-2001 supports only traditional suffix rules, every object built
318+
in a separate directory must have an explicit rule. For example:
319319

320320
objects/evalbuffer.o: evalbuffer.c
321321
$(CCC) -o $@ evalbuffer.c
322322

323-
This verbosity ensures that the same Makefile builds Vim unchanged with
324-
the default `make` on Linux, *BSD, macOS, Solaris, AIX, HP-UX and virtually
325-
any Unix-like OS.
323+
This verbosity ensures that the same Makefile builds Vim unchanged with the
324+
default `make` on Linux, *BSD, macOS, Solaris, AIX, HP-UX and virtually any
325+
Unix-like OS.
326326

327-
Some platform-specific Makefiles (e.g., for Windows, NSIS, or Cygwin) may
328-
use more advanced features when compatibility with basic make is not
329-
required.
327+
Some platform-specific Makefiles (e.g., for Windows, NSIS, or Cygwin) may use
328+
more advanced features when compatibility with basic make is not required.
330329

331330

332331
C COMPILER *assumptions-C-compiler*
@@ -343,8 +342,8 @@ In addition, the following two `C99` features are explicitly allowed:
343342
`//` comments, as required by |style-comments|;
344343
– the `_Bool` type.
345344

346-
Platform-specific code may use any newer compiler features supported on
347-
that platform.
345+
Platform-specific code may use any newer compiler features supported on that
346+
platform.
348347

349348

350349
SIZE OF VARIABLES *assumptions-variables*

runtime/doc/eval.txt

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

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -3312,7 +3312,7 @@ text...
33123312
CODE
33133313
<
33143314
*E121*
3315-
:let {var-name} .. List the value of variable {var-name}. Multiple
3315+
:let {var-name} ... List the value of variable {var-name}. Multiple
33163316
variable names may be given. Special names recognized
33173317
here: *E738*
33183318
g: global variables

0 commit comments

Comments
 (0)