thac0/vim
1
0
Fork 0
forked from aniani/vim
Code

runtime(doc): Tweak documentation style a bit

Browse Source 
closes: #11419

Signed-off-by: h-east <h.east.727@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
h-east 2024-11-09 18:37:32 +01:00 committed by Christian Brabandt
parent 50732c7ba6
commit 624bb83619
No known key found for this signature in database
GPG Key ID: F3F92DA383FDDE09
9 changed files with 71 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
runtime/defaults.vim
View File

@ -1,7 +1,7 @@
" The default vimrc file. " The default vimrc file.
" "
" Maintainer: The Vim Project <https://github.com/vim/vim> " Maintainer: The Vim Project <https://github.com/vim/vim>
" Last Change: 2024 Nov 03 " Last Change: 2024 Nov 09
" Former Maintainer: Bram Moolenaar <Bram@vim.org> " Former Maintainer: Bram Moolenaar <Bram@vim.org>
" "
" This is loaded if no vimrc file was found. " This is loaded if no vimrc file was found.

2
runtime/doc/builtin.txt
View File

@ -1,4 +1,4 @@
*builtin.txt* For Vim version 9.1. Last change: 2024 Nov 06 *builtin.txt* For Vim version 9.1. Last change: 2024 Nov 09
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar

6
runtime/doc/filetype.txt
View File

@ -1,4 +1,4 @@
*filetype.txt* For Vim version 9.1. Last change: 2024 Oct 21 *filetype.txt* For Vim version 9.1. Last change: 2024 Nov 09
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -946,8 +946,8 @@ To enable: >
let g:typst_folding = 1 let g:typst_folding = 1
< <
*g:typst_foldnested* *g:typst_foldnested*
When |TRUE| the Typst filetype plugin will fold nested heading under their parents When |TRUE| the Typst filetype plugin will fold nested heading under their
(default: |TRUE|) parents. (default: |TRUE|)
To disable: > To disable: >
let g:typst_foldnested = 0 let g:typst_foldnested = 0

6
runtime/doc/if_pyth.txt
View File

@ -1,4 +1,4 @@
*if_pyth.txt* For Vim version 9.1. Last change: 2024 Nov 06 *if_pyth.txt* For Vim version 9.1. Last change: 2024 Nov 09
VIM REFERENCE MANUAL by Paul Moore VIM REFERENCE MANUAL by Paul Moore
@ -201,8 +201,8 @@ vim.eval(str) *python-eval*
[{'cmd': '/^eval_expr(arg, nextcmd)$/', 'static': 0, 'name': ~ [{'cmd': '/^eval_expr(arg, nextcmd)$/', 'static': 0, 'name': ~
'eval_expr', 'kind': 'f', 'filename': './src/eval.c'}] ~ 'eval_expr', 'kind': 'f', 'filename': './src/eval.c'}] ~
NOTE: In vim9script, local variables in def functions are not visible NOTE: In Vim9 script, local variables in def functions are not visible
to to python evaluations. To pass local variables to python evaluations, to python evaluations. To pass local variables to python evaluations,
use the {locals} dict when calling |py3eval()| and friends. use the {locals} dict when calling |py3eval()| and friends.
vim.bindeval(str) *python-bindeval* vim.bindeval(str) *python-bindeval*

2
runtime/doc/pattern.txt
View File

@ -1,4 +1,4 @@
*pattern.txt* For Vim version 9.1. Last change: 2024 Jun 18 *pattern.txt* For Vim version 9.1. Last change: 2024 Nov 09
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar

2
runtime/doc/pi_netrw.txt
View File

@ -1,4 +1,4 @@
*pi_netrw.txt* For Vim version 9.1. Last change: 2024 Nov 02 *pi_netrw.txt* For Vim version 9.1. Last change: 2024 Nov 09
------------------------------------------------ ------------------------------------------------
NETRW REFERENCE MANUAL by Charles E. Campbell NETRW REFERENCE MANUAL by Charles E. Campbell

6
runtime/doc/pi_tutor.txt
View File

@ -1,4 +1,4 @@
*pi_tutor.txt* For Vim version 9.1. Last change: 2024 Nov 03 *pi_tutor.txt* For Vim version 9.1. Last change: 2024 Nov 09
INTERACTIVE TUTORIALS FOR VIM *vim-tutor-mode* INTERACTIVE TUTORIALS FOR VIM *vim-tutor-mode*
@ -19,8 +19,8 @@ by double-clicking them.
:Tutor {tutorial} Opens a tutorial. Command-line completion for :Tutor {tutorial} Opens a tutorial. Command-line completion for
{tutorial} is provided, the candidates are a list of {tutorial} is provided, the candidates are a list of
'.tutor' files found in the 'tutor/' folder in '.tutor' files found in the 'tutor/' folder in
the 'runtimepath'. Tutorials prefixed with 'vim-' will the 'runtimepath'. Tutorials prefixed with 'vim-'
always be shown first. will always be shown first.
If no {tutorial} is provided, the command starts the If no {tutorial} is provided, the command starts the
'vim-01-beginner' tutorial, which is equivalent to 'vim-01-beginner' tutorial, which is equivalent to

51
runtime/doc/syntax.txt
View File

@ -1,4 +1,4 @@
*syntax.txt* For Vim version 9.1. Last change: 2024 Oct 22 *syntax.txt* For Vim version 9.1. Last change: 2024 Nov 09
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -1679,20 +1679,20 @@ on" command in your .vimrc file.
When you edit an existing Fortran file, the syntax script will assume free When you edit an existing Fortran file, the syntax script will assume free
source form if the fortran_free_source variable has been set, and assumes source form if the fortran_free_source variable has been set, and assumes
fixed source form if the fortran_fixed_source variable has been set. Suppose fixed source form if the fortran_fixed_source variable has been set. Suppose
neither of these variables have been set. In that case, the syntax script attempts to neither of these variables have been set. In that case, the syntax script
determine which source form has been used by examining the file extension attempts to determine which source form has been used by examining the file
using conventions common to the ifort, gfortran, Cray, NAG, and PathScale extension using conventions common to the ifort, gfortran, Cray, NAG, and
compilers (.f, .for, .f77 for fixed-source, .f90, .f95, .f03, .f08 for PathScale compilers (.f, .for, .f77 for fixed-source, .f90, .f95, .f03, .f08
free-source). No default is used for the .fpp and .ftn file extensions because for free-source). No default is used for the .fpp and .ftn file extensions
different compilers treat them differently. If none of this works, then the because different compilers treat them differently. If none of this works,
script examines the first five columns of the first 500 lines of your file. If then the script examines the first five columns of the first 500 lines of your
no signs of free source form are detected, then the file is assumed to be in file. If no signs of free source form are detected, then the file is assumed
fixed source form. The algorithm should work in the vast majority of cases. to be in fixed source form. The algorithm should work in the vast majority of
In some cases, such as a file that begins with 500 or more full-line comments, cases. In some cases, such as a file that begins with 500 or more full-line
the script may incorrectly decide that the code is in fixed form. If that comments, the script may incorrectly decide that the code is in fixed form.
happens, just add a non-comment statement beginning anywhere in the first five If that happens, just add a non-comment statement beginning anywhere in the
columns of the first twenty-five lines, save (:w), and then reload (:e!) the first five columns of the first twenty-five lines, save (:w), and then reload
file. (:e!) the file.
Vendor extensions ~ Vendor extensions ~
Fixed-form Fortran requires a maximum line length of 72 characters but the Fixed-form Fortran requires a maximum line length of 72 characters but the
@ -2226,9 +2226,9 @@ define the vim variable 'lace_case_insensitive' in your startup file: >
LF (LFRC) *lf.vim* *ft-lf-syntax* *g:lf_shell_syntax* LF (LFRC) *lf.vim* *ft-lf-syntax* *g:lf_shell_syntax*
*b:lf_shell_syntax* *b:lf_shell_syntax*
For the lf file manager configuration files (lfrc) the shell commands For the lf file manager configuration files (lfrc) the shell commands syntax
syntax highlighting can be changed globally and per buffer by setting highlighting can be changed globally and per buffer by setting a different
a different 'include' command search pattern using these variables: 'include' command search pattern using these variables: >
let g:lf_shell_syntax = "syntax/dosbatch.vim" let g:lf_shell_syntax = "syntax/dosbatch.vim"
let b:lf_shell_syntax = "syntax/zsh.vim" let b:lf_shell_syntax = "syntax/zsh.vim"
@ -2538,9 +2538,10 @@ set "msql_minlines" to the value you desire. Example: >
:let msql_minlines = 200 :let msql_minlines = 200
NEOMUTT *neomutt.vim* *ft-neomuttrc-syntax* *ft-neomuttlog-syntax* NEOMUTT *neomutt.vim* *ft-neomuttrc-syntax*
*ft-neomuttlog-syntax*
To disable the default NeoMutt log colors > To disable the default NeoMutt log colors: >
:let g:neolog_disable_default_colors = 1 :let g:neolog_disable_default_colors = 1
@ -2710,9 +2711,9 @@ specified. Default = 1 >
:let g:pandoc#syntax#codeblocks#embeds#use = 1 :let g:pandoc#syntax#codeblocks#embeds#use = 1
For specify what languages and using what syntax files to highlight embeds. This is a For specify what languages and using what syntax files to highlight embeds.
list of language names. When the language pandoc and vim use don't match, you This is a list of language names. When the language pandoc and vim use don't
can use the "PANDOC=VIM" syntax. For example: > match, you can use the "PANDOC=VIM" syntax. For example: >
:let g:pandoc#syntax#codeblocks#embeds#langs = ["ruby", "bash=sh"] :let g:pandoc#syntax#codeblocks#embeds#langs = ["ruby", "bash=sh"]
@ -5721,8 +5722,8 @@ guisp={color-name} *highlight-guisp*
:highlight Comment guifg=#11f0c3 guibg=#ff00ff :highlight Comment guifg=#11f0c3 guibg=#ff00ff
< <
If you are authoring a color scheme and use the same hexadecimal value If you are authoring a color scheme and use the same hexadecimal value
repeatedly, you can define a (lower case) name for it in |v:colornames|. repeatedly, you can define a (lower case) name for it in
For example: > |v:colornames|. For example: >
# provide a default value for this color but allow the user to # provide a default value for this color but allow the user to
# override it. # override it.

2
runtime/doc/undo.txt
View File

@ -1,4 +1,4 @@
*undo.txt* For Vim version 9.1. Last change: 2024 Sep 29 *undo.txt* For Vim version 9.1. Last change: 2024 Nov 09
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar