GitHub/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim synced 2025-07-16 01:01:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: various fixes (#26929)

Browse Source 
Co-authored-by: Patrick Bollinger <owner@pjbollinger.com>
Co-authored-by: vilo1839 <139687192+vilo1839@users.noreply.github.com>
This commit is contained in:
dundargoc
2024-01-17 07:01:39 +01:00
committed by GitHub
parent 2fce95ec43
commit b3e5587b7f
8 changed files with 15 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
INSTALL.md
View File

@ -3,7 +3,7 @@ You can install Neovim from [download](#install-from-download), [package](#insta
--- ---
- To start Neovim, run `nvim` (not `neovim`). - To start Neovim, run `nvim` (not `neovim`).
- [Discover plugins](Related-projects#plugins). - [Discover plugins](https://github.com/neovim/neovim/wiki/Related-projects#plugins).
- Before upgrading to a new version, **check [Breaking Changes](https://neovim.io/doc/user/news.html#news-breaking).** - Before upgrading to a new version, **check [Breaking Changes](https://neovim.io/doc/user/news.html#news-breaking).**
- For config (vimrc) see [the FAQ](https://neovim.io/doc/user/faq.html#faq-general). - For config (vimrc) see [the FAQ](https://neovim.io/doc/user/faq.html#faq-general).

2
MAINTAIN.md
View File

@ -73,7 +73,7 @@ When a (non-experimental) feature is slated to be removed it should:
1. Be _soft_ deprecated in the _next_ release 1. Be _soft_ deprecated in the _next_ release
- Use of the deprecated feature will still work. - Use of the deprecated feature will still work.
- This means deprecating via documentation and annotation (`@deprecated`) only. - This means deprecating via documentation and annotation (`@deprecated`).
- Include a note in `news.txt` under `DEPRECATIONS`. - Include a note in `news.txt` under `DEPRECATIONS`.
- For Lua features, use `vim.deprecate()`. The specified version is the - For Lua features, use `vim.deprecate()`. The specified version is the
current minor version + 2. For example, if the current version is current minor version + 2. For example, if the current version is

5
runtime/doc/dev_style.txt
View File

@ -46,7 +46,9 @@ Headers system ~
Nvim uses two types of headers. There are "normal" headers and "defs" headers. Nvim uses two types of headers. There are "normal" headers and "defs" headers.
Typically, each normal header will have a corresponding defs header, e.g. Typically, each normal header will have a corresponding defs header, e.g.
`fileio.h` and `fileio_defs.h`. This distinction is done to minimize `fileio.h` and `fileio_defs.h`. This distinction is done to minimize
recompilation on change. The goal is to achieve the following: recompilation on change. The reason for this is because adding a function or
modifying a function's signature happens more frequently than changing a type
The goal is to achieve the following:
- All headers (defs and normal) must include only defs headers, system - All headers (defs and normal) must include only defs headers, system
headers, and generated declarations. In other words, headers must not headers, and generated declarations. In other words, headers must not
@ -69,7 +71,6 @@ Non-symbols:
- structs - structs
- enums - enums
- All symbols must be moved to normal headers. - All symbols must be moved to normal headers.
- Non-symbols used by multiple headers should be moved to defs headers. This - Non-symbols used by multiple headers should be moved to defs headers. This

2
runtime/doc/options.txt
View File

@ -5926,7 +5926,7 @@ A jump table for the options with a short description can be found at |Q_op|.
The 'statuscolumn' width follows that of the default columns and The 'statuscolumn' width follows that of the default columns and
adapts to the |'numberwidth'|, |'signcolumn'| and |'foldcolumn'| option adapts to the |'numberwidth'|, |'signcolumn'| and |'foldcolumn'| option
values (regardless of whether the sign and fold items are present). values (regardless of whether the sign and fold items are present).
Aditionally, the 'statuscolumn' grows with the size of the evaluated Additionally, the 'statuscolumn' grows with the size of the evaluated
format string, up to a point (following the maximum size of the default format string, up to a point (following the maximum size of the default
fold, sign and number columns). Shrinking only happens when the number fold, sign and number columns). Shrinking only happens when the number
of lines in a buffer changes, or the 'statuscolumn' option is set. of lines in a buffer changes, or the 'statuscolumn' option is set.

12
runtime/doc/ui.txt
View File

@ -26,12 +26,12 @@ with these (optional) keys:
*ui-rgb* *ui-rgb*
- `rgb` Decides the color format. - `rgb` Decides the color format.
- true: (default) 24-bit RGB colors - true: (default) 24-bit RGB colors
- false: Terminal colors (8-bit, max 256) - false: Terminal colors (8-bit, max 256)
*ui-override* *ui-override*
- `override` Decides how UI capabilities are resolved. - `override` Decides how UI capabilities are resolved.
- true: Enable requested UI capabilities, even if not - true: Enable requested UI capabilities, even if not
supported by all connected UIs (including |TUI|). supported by all connected UIs (including |TUI|).
- false: (default) Disable UI capabilities not - false: (default) Disable UI capabilities not
supported by all connected UIs (including TUI). supported by all connected UIs (including TUI).
@ -138,7 +138,7 @@ procedure:
to set |g:| variables visible to init.vim to set |g:| variables visible to init.vim
3. If the UI wants to do additional setup after user config is loaded, 3. If the UI wants to do additional setup after user config is loaded,
register a VimEnter autocmd: >vim register a VimEnter autocmd: >lua
nvim_command("autocmd VimEnter * call rpcrequest(1, 'vimenter')") nvim_command("autocmd VimEnter * call rpcrequest(1, 'vimenter')")
4. Now invoke |nvim_ui_attach()|. The UI must handle user input by now: 4. Now invoke |nvim_ui_attach()|. The UI must handle user input by now:
@ -188,7 +188,7 @@ the editor.
`attr_id`: Cursor attribute id (defined by `hl_attr_define`). `attr_id`: Cursor attribute id (defined by `hl_attr_define`).
When attr_id is 0, the background and foreground When attr_id is 0, the background and foreground
colors should be swapped. colors should be swapped.
`attr_id_lm`: Cursor attribute id for when 'langmap' is active. `attr_id_lm`: Cursor attribute id for when |:lmap| is on.
`short_name`: Mode code name, see 'guicursor'. `short_name`: Mode code name, see 'guicursor'.
`name`: Mode descriptive name. `name`: Mode descriptive name.
`mouse_shape`: (To be implemented.) `mouse_shape`: (To be implemented.)
@ -555,7 +555,7 @@ with the following possible keys:
`kind`: always present. One of the following values: `kind`: always present. One of the following values:
"ui": Builtin UI highlight. |highlight-groups| "ui": Builtin UI highlight. |highlight-groups|
"syntax": Highlight applied to a buffer by a syntax declaration or "syntax": Highlight applied to a buffer by a syntax declaration or
other runtime/plugin functionality such as other runtime/plugin functionality such as
|nvim_buf_add_highlight()| |nvim_buf_add_highlight()|
"terminal": highlight from a process running in a |terminal-emulator|. "terminal": highlight from a process running in a |terminal-emulator|.
Contains no further semantic information. Contains no further semantic information.

2
runtime/lua/vim/_meta/options.lua generated
View File

@ -6362,7 +6362,7 @@ vim.go.sol = vim.go.startofline
--- The 'statuscolumn' width follows that of the default columns and --- The 'statuscolumn' width follows that of the default columns and
--- adapts to the `'numberwidth'`, `'signcolumn'` and `'foldcolumn'` option --- adapts to the `'numberwidth'`, `'signcolumn'` and `'foldcolumn'` option
--- values (regardless of whether the sign and fold items are present). --- values (regardless of whether the sign and fold items are present).
--- Aditionally, the 'statuscolumn' grows with the size of the evaluated --- Additionally, the 'statuscolumn' grows with the size of the evaluated
--- format string, up to a point (following the maximum size of the default --- format string, up to a point (following the maximum size of the default
--- fold, sign and number columns). Shrinking only happens when the number --- fold, sign and number columns). Shrinking only happens when the number
--- of lines in a buffer changes, or the 'statuscolumn' option is set. --- of lines in a buffer changes, or the 'statuscolumn' option is set.

2
runtime/tutor/en/vim-01-beginner.tutor
View File

@ -968,7 +968,7 @@ Here's a bunch of them:
- *Learn Vim Progressively*: - *Learn Vim Progressively*:
http://yannesposito.com/Scratch/en/blog/Learn-Vim-Progressively/ http://yannesposito.com/Scratch/en/blog/Learn-Vim-Progressively/
- *Learning Vim in 2013*: - *Learning Vim in 2014*:
http://benmccormick.org/learning-vim-in-2014/ http://benmccormick.org/learning-vim-in-2014/
- *Vimcasts*: - *Vimcasts*:
http://vimcasts.org/ http://vimcasts.org/

2
src/nvim/options.lua
View File

@ -8024,7 +8024,7 @@ return {
The 'statuscolumn' width follows that of the default columns and The 'statuscolumn' width follows that of the default columns and
adapts to the |'numberwidth'|, |'signcolumn'| and |'foldcolumn'| option adapts to the |'numberwidth'|, |'signcolumn'| and |'foldcolumn'| option
values (regardless of whether the sign and fold items are present). values (regardless of whether the sign and fold items are present).
Aditionally, the 'statuscolumn' grows with the size of the evaluated Additionally, the 'statuscolumn' grows with the size of the evaluated
format string, up to a point (following the maximum size of the default format string, up to a point (following the maximum size of the default
fold, sign and number columns). Shrinking only happens when the number fold, sign and number columns). Shrinking only happens when the number
of lines in a buffer changes, or the 'statuscolumn' option is set. of lines in a buffer changes, or the 'statuscolumn' option is set.