From 0814086a23315873aae8d9920c1c511fd62e8c86 Mon Sep 17 00:00:00 2001 From: dundargoc <33953936+dundargoc@users.noreply.github.com> Date: Sun, 13 Apr 2025 01:41:54 +0200 Subject: [PATCH] docs: misc (#33093) Co-authored-by: Jx Co-authored-by: Richard Dzenis Co-authored-by: Shixian Sheng Co-authored-by: Sourabh Kumar Co-authored-by: Yegor Yefremov Co-authored-by: zeertzjq --- .github/workflows/notes.md | 2 +- BUILD.md | 2 +- INSTALL.md | 2 +- MAINTAIN.md | 2 +- runtime/doc/lua-guide.txt | 3 --- runtime/doc/news-0.11.txt | 17 ++++++----------- runtime/doc/news.txt | 10 ++++++++-- src/cjson/lua_cjson.c | 2 +- 8 files changed, 19 insertions(+), 21 deletions(-) diff --git a/.github/workflows/notes.md b/.github/workflows/notes.md index ac66e0a816..b40ee8a3c4 100644 --- a/.github/workflows/notes.md +++ b/.github/workflows/notes.md @@ -36,7 +36,7 @@ Note: On Windows "Server" you may need to [install vcruntime140.dll](https://lea ### Linux (x86_64) -If your system does not have the [required glibc version](https://neovim.io/doc/user/support.html#supported-platforms), try the (unsupported) [builds for older glibc](https://github.com/neovim/neovim-releases). +If your system does not have the required glibc version, try the (unsupported) [builds for older glibc](https://github.com/neovim/neovim-releases). #### AppImage diff --git a/BUILD.md b/BUILD.md index cfa26a4569..6f808214e1 100644 --- a/BUILD.md +++ b/BUILD.md @@ -223,7 +223,7 @@ rebuild: ## Third-party dependencies -Reference the [Debian package](https://packages.debian.org/sid/source/neovim) (or alternatively, the [Homebrew formula](https://github.com/Homebrew/homebrew-core/blob/master/Formula/neovim.rb)) for the precise list of dependencies/versions. +Reference the [Debian package](https://packages.debian.org/sid/source/neovim) (or alternatively, the [Homebrew formula](https://github.com/Homebrew/homebrew-core/blob/master/Formula/n/neovim.rb)) for the precise list of dependencies/versions. To build the bundled dependencies using CMake: diff --git a/INSTALL.md b/INSTALL.md index 6c2ec3a273..7e6ed3f117 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -62,7 +62,7 @@ Several Neovim GUIs are available from scoop (extras): [scoop.sh/#/apps?q=neovim - Add the `bin` folder (e.g. `C:\Program Files\nvim\bin`) to your PATH. - This makes it easy to run `nvim` from anywhere. -- If `:set spell` does not work, create the `C:/Users/foo/AppData/Local/nvim/site/spell` folder. +- If `:set spell` does not work, create the `%LOCALAPPDATA%/nvim-data/site/spell` folder. You can then copy your spell files over (for English, located [here](https://github.com/vim/vim/blob/master/runtime/spell/en.utf-8.spl) and [here](https://github.com/vim/vim/blob/master/runtime/spell/en.utf-8.sug)); diff --git a/MAINTAIN.md b/MAINTAIN.md index 13e2c5e772..74bda2dd26 100644 --- a/MAINTAIN.md +++ b/MAINTAIN.md @@ -81,7 +81,7 @@ When a (non-experimental) feature is slated to be removed it should: as described for Lua features. - `vim.deprecate(…, 'x.y.z')` where major version `x` is greater than the current Nvim major version, is always treated as _soft_ deprecation. -2. Be _hard_ deprecated in a following a release in which it was soft deprecated. +2. Be _hard_ deprecated in a release following the release in which it was soft deprecated. - Use of the deprecated feature will still work but should issue a warning. - Features implemented in C will need bespoke implementations to communicate to users that the feature is deprecated. diff --git a/runtime/doc/lua-guide.txt b/runtime/doc/lua-guide.txt index d0d148f689..54e3eec700 100644 --- a/runtime/doc/lua-guide.txt +++ b/runtime/doc/lua-guide.txt @@ -122,7 +122,6 @@ Let's assume you have the following directory structure: |-- syntax/ |-- init.vim < - Then the following Lua code will load `myluamodule.lua`: >lua require("myluamodule") @@ -135,7 +134,6 @@ Similarly, loading `other_modules/anothermodule.lua` is done via -- or require('other_modules.anothermodule') < - Note how "submodules" are just subdirectories; the `.` is equivalent to the path separator `/` (even on Windows). @@ -531,7 +529,6 @@ Examples: callback = function() print("My Plugin Works!") end, }) < - Nvim will always call a Lua function with a single table containing information about the triggered autocommand. The most useful keys are • `match`: a string that matched the `pattern` (see ||) diff --git a/runtime/doc/news-0.11.txt b/runtime/doc/news-0.11.txt index 36d96b8842..be7820f063 100644 --- a/runtime/doc/news-0.11.txt +++ b/runtime/doc/news-0.11.txt @@ -122,10 +122,6 @@ OPTIONS • Setting |hidden-options| now gives an error. In particular, setting 'noshellslash' is now only allowed on Windows. -PLUGINS - -• TODO - TREESITTER • |Query:iter_matches()| correctly returns all matching nodes in a match @@ -139,12 +135,11 @@ TREESITTER if no languages are explicitly registered. • |vim.treesitter.language.add()| returns `true` if a parser was loaded successfully and `nil,errmsg` otherwise instead of throwing an error. -• |vim.treesitter.get_parser()| and |vim.treesitter.start()| no longer parse - the tree before returning. Scripts must call |LanguageTree:parse()| explicitly. >lua +• |vim.treesitter.get_parser()| and |vim.treesitter.start()| no longer parse the + tree before returning. Scripts must call |LanguageTree:parse()| explicitly. >lua local p = vim.treesitter.get_parser(0, 'c') p:parse() • |vim.treesitter.get_parser()| expects its buffer to be loaded. -< TUI @@ -179,7 +174,6 @@ API aligned text that truncates before covering up buffer text. • `virt_lines_overflow` field accepts value `scroll` to enable horizontal scrolling for virtual lines with 'nowrap'. -• |vim.hl.range()| now has a optional `timeout` field which allows for a timed highlight DEFAULTS @@ -245,8 +239,7 @@ EDITOR • |hl-ComplMatchIns| shows matched text of the currently inserted completion. • |hl-PmenuMatch| and |hl-PmenuMatchSel| show matched text in completion popup. • |gO| now works in `help`, `checkhealth`, and `markdown` buffers. -• Jump between sections in `help` and `checkhealth` buffers with `[[` and - `]]`. +• Jump between sections in `help` and `checkhealth` buffers with `[[` and `]]`. EVENTS @@ -305,6 +298,8 @@ LUA • |vim.fs.relpath()| gets relative path compared to base path. • |vim.fs.dir()| and |vim.fs.find()| can now follow symbolic links, the behavior can be turn on using the new `follow` option. +• |vim.hl.range()| now has a optional `timeout` field which allows for a timed + highlight. • |vim.text.indent()| indents/dedents text. OPTIONS @@ -315,7 +310,7 @@ OPTIONS • 'messagesopt' configures |:messages| and |hit-enter| prompt. • 'tabclose' controls which tab page to focus when closing a tab page. • 'eventignorewin' to persistently ignore events in a window. -• 'winborder' sets the default border for |floating-windows| +• 'winborder' sets the default border for |floating-windows|. PERFORMANCE diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index bec75cee85..73bd66f777 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -66,7 +66,7 @@ EVENTS HIGHLIGHTS -• |hl-DiffTextAdd| highlights added text within a changed line. +• todo LSP @@ -125,6 +125,10 @@ EVENTS • todo +HIGHLIGHTS + +• |hl-DiffTextAdd| highlights added text within a changed line. + LSP • |vim.lsp.ClientConfig| gained `workspace_required`. @@ -135,9 +139,11 @@ LUA OPTIONS +• 'autowriteall' writes all buffers upon receiving `SIGHUP`, `SIGQUIT` or `SIGTSTP`. • 'completefuzzycollect' enables fuzzy collection of candidates for (some) |ins-completion| modes. -• 'autowriteall' write all buffers upon receiving `SIGHUP`, `SIGQUIT` or `SIGTSTP`. +• 'diffopt' `inline:` configures diff highlighting for changes within a line. +• 'pummaxwidth' sets maximum width for the completion popup menu. • 'winborder' "bold" style. • |g:clipboard| accepts a string name to force any builtin clipboard tool. diff --git a/src/cjson/lua_cjson.c b/src/cjson/lua_cjson.c index bcd464061c..3119ffc2d7 100644 --- a/src/cjson/lua_cjson.c +++ b/src/cjson/lua_cjson.c @@ -844,7 +844,7 @@ static void json_append_object(lua_State *l, json_encode_t *ctx, strbuf_append_char(json, '}'); } -/* Serialise Lua data into JSON string. Return 1 if error an error happend, else 0 */ +/* Serialise Lua data into JSON string. Return 1 if an error happened, else 0. */ static int json_append_data(lua_State *l, json_encode_t *ctx, int current_depth) {