docs: fix typos (#27868)

Co-authored-by: ite-usagi <77563904+ite-usagi@users.noreply.github.com> Co-authored-by: v-sim <56476039+v-sim@users.noreply.github.com> Co-authored-by: Evgeni Chasnovski <evgeni.chasnovski@gmail.com> Co-authored-by: zeertzjq <zeertzjq@outlook.com> Co-authored-by: Quico Augustijn <quico.public@gmail.com> Co-authored-by: nhld <nahnera@gmail.com> Co-authored-by: francisco souza <108725+fsouza@users.noreply.github.com>
2024-12-19 02:34:59 -07:00 · 2024-03-28 02:32:32 +01:00 · 2024-03-28 02:32:32 +01:00 · a89ce89742
commit a89ce89742
parent 4ee9e58056
21 changed files with 65 additions and 62 deletions
--- a/.github/workflows/notes.md
+++ b/.github/workflows/notes.md
@ -20,10 +20,10 @@ ${NVIM_VERSION}

 ### macOS (x86_64)

-1. Download **nvim-macos-x86_86.tar.gz**
-2. Run `xattr -c ./nvim-macos-x86_86.tar.gz` (to avoid "unknown developer" warning)
-3. Extract: `tar xzvf nvim-macos-x86_86.tar.gz`
-4. Run `./nvim-macos-x86_86/bin/nvim`
+1. Download **nvim-macos-x86_64.tar.gz**
+2. Run `xattr -c ./nvim-macos-x86_64.tar.gz` (to avoid "unknown developer" warning)
+3. Extract: `tar xzvf nvim-macos-x86_64.tar.gz`
+4. Run `./nvim-macos-x86_64/bin/nvim`

 ### macOS (arm64)

--- a/BUILD.md
+++ b/BUILD.md
@ -16,7 +16,7 @@

 **Notes**:
 - From the repository's root directory, running `make` will download and build all the needed dependencies and put the `nvim` executable in `build/bin`.
- Third-party dependencies (libuv, LuaJIT, etc.) are downloaded automatically to `.deps/`. See the [FAQ](FAQ#build-issues) if you have issues.
+- Third-party dependencies (libuv, LuaJIT, etc.) are downloaded automatically to `.deps/`. See the [FAQ](https://neovim.io/doc/user/faq.html#faq-build) if you have issues.
 - After building, you can run the `nvim` executable without installing it by running `VIMRUNTIME=runtime ./build/bin/nvim`.
 - If you plan to develop Neovim, install [Ninja](https://ninja-build.org/) for faster builds. It will automatically be used.
 - Install [ccache](https://ccache.dev/) for faster rebuilds of Neovim. It's used by default. To disable it, use `CCACHE_DISABLE=true make`.
@ -345,7 +345,7 @@ buildPhase
 ```

 Tests are not available by default, because of some unfixed failures. You can enable them via adding this package in your overlay:
-``` 
+```
  neovim-dev = (super.pkgs.neovim-unwrapped.override  {
    doCheck=true;
  }).overrideAttrs(oa:{
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@ -18,7 +18,7 @@ if(POLICY CMP0135)
 endif()

 if(XCODE)
-  message(FATAL_ERROR [[Xcode generator is not supported. Use "Ninja" or "Unix Makefiles" instead.]])
+  message(FATAL_ERROR [[Xcode generator is not supported. Use "Ninja" or "Unix Makefiles" instead]])
 endif()

 # Point CMake at any custom modules we may ship
--- a/INSTALL.md
+++ b/INSTALL.md
@ -60,9 +60,9 @@ 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` and `nvim-qt` from anywhere.
- If `:set spell` does not work, create the `C:/Users/foo/AppData/Local/nvim/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 
+- If `:set spell` does not work, create the `C:/Users/foo/AppData/Local/nvim/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));
 - For Python plugins you need the `pynvim` module. "Virtual envs" are recommended. After activating the virtual env do `pip install pynvim` (in *both*). Edit your `init.vim` so that it contains the path to the env's Python executable:
    ```vim
@ -78,9 +78,17 @@ Several Neovim GUIs are available from scoop (extras): [scoop.sh/#/apps?q=neovim

 The [Releases](https://github.com/neovim/neovim/releases) page provides pre-built binaries for macOS 10.15+.

-    curl -LO https://github.com/neovim/neovim/releases/download/nightly/nvim-macos.tar.gz
-    tar xzf nvim-macos.tar.gz
-    ./nvim-macos/bin/nvim
+For x86_64:
+
+    curl -LO https://github.com/neovim/neovim/releases/download/nightly/nvim-macos-x86_64.tar.gz
+    tar xzf nvim-macos-x86_64.tar.gz
+    ./nvim-macos-x86_64/bin/nvim
+
+For arm64:
+
+    curl -LO https://github.com/neovim/neovim/releases/download/nightly/nvim-macos-arm64.tar.gz
+    tar xzf nvim-macos-arm64.tar.gz
+    ./nvim-macos-arm64/bin/nvim

 ### [Homebrew](https://brew.sh) on macOS or Linux

@ -122,7 +130,7 @@ To expose nvim globally:

 And the following line to `~/.bashrc`:

-    export PATH="$PATH:/opt/nvim/" 
+    export PATH="$PATH:/opt/nvim/"

 If the `./nvim.appimage` command fails, try:
 ```sh
@ -206,7 +214,7 @@ You can find Neovim on [Flathub](https://flathub.org/apps/details/io.neovim.nvim

 You can add `/var/lib/flatpak/exports/bin` (or `~/.local/share/flatpak/exports/bin` if you used `--user`) to the `$PATH` and run it with `io.neovim.nvim`.

-Note that Flatpak'ed Neovim will look for `init.vim` in `~/.var/app/io.neovim.nvim/config/nvim` instead of `~/.config/nvim`. 
+Note that Flatpak'ed Neovim will look for `init.vim` in `~/.var/app/io.neovim.nvim/config/nvim` instead of `~/.config/nvim`.

 ### Gentoo Linux

@ -259,7 +267,7 @@ Neovim can be installed with:
    sudo zypper in neovim

 To install the Python modules:
-    
+
    sudo zypper in python-neovim python3-neovim

 ### PLD Linux
--- a/cmake.deps/cmake/BuildLuajit.cmake
+++ b/cmake.deps/cmake/BuildLuajit.cmake
@ -1,6 +1,3 @@
-# BuildLuajit(TARGET targetname CONFIGURE_COMMAND ... BUILD_COMMAND ... INSTALL_COMMAND ...)
-# Reusable function to build luajit, wraps ExternalProject_Add.
-# Failing to pass a command argument will result in no command being run
 function(BuildLuajit)
  cmake_parse_arguments(_luajit
    ""
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@ -2447,7 +2447,7 @@ nvim_buf_set_mark({buffer}, {name}, {line}, {col}, {opts})
      • |nvim_buf_get_mark()|

 nvim_buf_set_name({buffer}, {name})                      *nvim_buf_set_name()*
-    Sets the full file name for a buffer
+    Sets the full file name for a buffer, like |:file_f|

    Parameters: ~
      • {buffer}  Buffer handle, or 0 for current buffer
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@ -968,7 +968,7 @@ vim.str_byteindex({str}, {index}, {use_utf16})           *vim.str_byteindex()*
    Convert UTF-32 or UTF-16 {index} to byte index. If {use_utf16} is not
    supplied, it defaults to false (use UTF-32). Returns the byte index.

-    Invalid UTF-8 and NUL is treated like by |vim.str_byteindex()|. An {index}
+    Invalid UTF-8 and NUL is treated like in |vim.str_utfindex()|. An {index}
    in the middle of a UTF-16 sequence is rounded upwards to the end of that
    sequence.

--- a/runtime/doc/treesitter.txt
+++ b/runtime/doc/treesitter.txt
@ -149,7 +149,7 @@ TSNode:sexpr()                                          *TSNode:sexpr()*
    Get an S-expression representing the node as a string.

 TSNode:id()                                             *TSNode:id()*
-    Get an unique identifier for the node inside its own tree.
+    Get a unique identifier for the node inside its own tree.

    No guarantees are made about this identifier's internal representation,
    except for being a primitive Lua type with value equality (so not a
@ -524,7 +524,7 @@ the exact definition):
@keyword.operator       operators that are English words (e.g. `and`, `or`)
@keyword.import         keywords for including modules (e.g. `import`, `from` in Python)
@keyword.type           keywords defining composite types (e.g. `struct`, `enum`)
-@keyword.modifier       keywords definining type modifiers (e.g. `const`, `static`, `public`)
+@keyword.modifier       keywords defining type modifiers (e.g. `const`, `static`, `public`)
@keyword.repeat         keywords related to loops (e.g. `for`, `while`)
@keyword.return         keywords like `return` and `yield`
@keyword.debug          keywords related to debugging
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@ -669,7 +669,7 @@ function vim.api.nvim_buf_set_lines(buffer, start, end_, strict_indexing, replac
 --- @return boolean
 function vim.api.nvim_buf_set_mark(buffer, name, line, col, opts) end

--- Sets the full file name for a buffer
+--- Sets the full file name for a buffer, like `:file_f`
 ---
 --- @param buffer integer Buffer handle, or 0 for current buffer
 --- @param name string Buffer name
--- a/runtime/lua/vim/_meta/builtin.lua
+++ b/runtime/lua/vim/_meta/builtin.lua
@ -115,7 +115,7 @@ function vim.stricmp(a, b) end
 --- Convert UTF-32 or UTF-16 {index} to byte index. If {use_utf16} is not
 --- supplied, it defaults to false (use UTF-32). Returns the byte index.
 ---
--- Invalid UTF-8 and NUL is treated like by |vim.str_byteindex()|.
+--- Invalid UTF-8 and NUL is treated like in |vim.str_utfindex()|.
 --- An {index} in the middle of a UTF-16 sequence is rounded upwards to
 --- the end of that sequence.
 --- @param str string
--- a/runtime/tutor/en/vim-01-beginner.tutor
+++ b/runtime/tutor/en/vim-01-beginner.tutor
@ -39,7 +39,7 @@ instead of text to type.

 Now, move to the next lesson (use the `j`{normal} key to scroll down).

-## Lesson 1.1: MOVING THE CURSOR
+# Lesson 1.1: MOVING THE CURSOR

 ** To move the cursor, press the `h`, `j`, `k`, `l` keys as indicated. **

@ -87,7 +87,7 @@ NOTE: [:q!](:q) `<Enter>`{normal} discards any changes you made. In a few lesson

 5. Move the cursor down to Lesson 1.3.

-## Lesson 1.3: TEXT EDITING - DELETION
+# Lesson 1.3: TEXT EDITING: DELETION

 ** Press `x`{normal} to delete the character under the cursor. **

@ -251,8 +251,8 @@ The format for a delete command with the [d](d) delete operator is as follows:

  Thus typing `de`{normal} will delete from the cursor to the end of the word.

-NOTE:  Pressing just the motion while in Normal mode without an operator
-       will move the cursor as specified.
+NOTE: Pressing just the motion while in Normal mode without an operator
+      will move the cursor as specified.

 # Lesson 2.4: USING A COUNT FOR A MOTION

@ -381,7 +381,7 @@ b) Violets are blue,
 c) Intelligence is learned,
 a) Roses are red,

-NOTE: You can also put the text before the cursor with `P`{normal} (capital P)
+NOTE: You can also put the text before the cursor with `P`{normal} (capital P).

 # Lesson 3.2: THE REPLACE COMMAND

@ -534,7 +534,7 @@ NOTE: This is very useful in debugging a program with unmatched parentheses!
 ~~~ cmd
        :s/thee/the/
 ~~~
-    NOTE: the [:s](:s) command only changed the first match of "thee" in the line.
+    NOTE: The [:s](:s) command only changed the first match of "thee" in the line.

 3. Now type
 ~~~ cmd
@ -565,14 +565,14 @@ Usually thee best time to see thee flowers is in thee spring.
    to find every occurrence in the whole file, with a prompt whether to
    substitute or not.

-NOTE: You can also select the lines you want to substitute first using visual-mode.
+NOTE: You can also select the lines you want to substitute first using Visual mode.
      This will be explained more in a future lesson.

 # Lesson 4 SUMMARY

 1. `<C-g>`{normal}     displays your location and the file status.
    `G`{normal}         moves to the end of the file.
-    number `G`{normal} moves to that line number.
+    number `G`{normal}  moves to that line number.
    `gg`{normal}        moves to the first line.

 2. Typing `/`{normal} followed by a phrase searches FORWARD for the phrase.
@ -638,7 +638,7 @@ NOTE: All `:`{vim} commands are executed when you press `<Enter>`{normal}.
 ~~~ cmd
        :w TEST
 ~~~
-   (where TEST is the filename you chose.)
+    (where TEST is the filename you chose.)

 4. This saves the current file under the name TEST.
    To verify this, type `:!{unix:(ls),win:(dir)}`{vim} again to see your directory.
@ -688,8 +688,8 @@ NOTE: Pressing [v](v) starts [Visual selection](visual-mode). You can move the c

 1. Place the cursor just above this line.

-NOTE:  After executing Step 2 you will see text from Lesson 5.3. Then move
-       DOWN to see this lesson again.
+NOTE: After executing Step 2 you will see text from Lesson 5.3. Then move
+      DOWN to see this lesson again.

 2. Now retrieve your TEST file using the command

@ -810,9 +810,9 @@ NOTE: Replace mode is like Insert mode, but every typed character
 a) This is the first item.
 b)

-NOTE: you can use `y`{normal} as an operator: `yw`{normal} yanks one word.
+NOTE: You can use `y`{normal} as an operator: `yw`{normal} yanks one word.

-NOTE: you can use `P`{normal} to put before the cursor, rather than after.
+NOTE: You can use `P`{normal} to put before the cursor, rather than after.

 # Lesson 6.5: SET OPTION

@ -864,7 +864,7 @@ NOTE: If you want to ignore case for just one search command, use [\c](/\c)
 4. The `y`{normal} operator copies text, `p`{normal} pastes it.

 5. Typing a capital `R`{normal} enters Replace mode until `<Esc>`{normal} is
-     pressed.
+    pressed.

 6. Typing "[:set](:set) xxx" sets the option "xxx". Some options are:

@ -872,7 +872,7 @@ NOTE: If you want to ignore case for just one search command, use [\c](/\c)
        'is' 'incsearch'    show partial matches for a search phrase
        'hls' 'hlsearch'    highlight all matching phrases

-     You can either use the long or the short option name.
+    You can either use the long or the short option name.

 7. Prepend "no" to switch an option off:
 ~~~ cmd
@ -921,8 +921,8 @@ To start using more features create an "init.vim" file.

    `:w`{vim}

-  You can add all your preferred settings to this "init.vim" file.
-  For more information type `:help init.vim`{vim}.
+You can add all your preferred settings to this "init.vim" file.
+For more information type `:help init.vim`{vim}.

 # Lesson 7.3: COMPLETION

--- a/src/nvim/api/buffer.c
+++ b/src/nvim/api/buffer.c
@ -968,7 +968,7 @@ String nvim_buf_get_name(Buffer buffer, Error *err)
  return cstr_as_string(buf->b_ffname);
 }

-/// Sets the full file name for a buffer
+/// Sets the full file name for a buffer, like |:file_f|
 ///
 /// @param buffer     Buffer handle, or 0 for current buffer
 /// @param name       Buffer name
--- a/src/nvim/event/rstream.c
+++ b/src/nvim/event/rstream.c
@ -106,7 +106,7 @@ static void read_cb(uv_stream_t *uvstream, ssize_t cnt, const uv_buf_t *buf)
    // http://docs.libuv.org/en/latest/stream.html#c.uv_read_start.
    //
    // We don't need to do anything with the RBuffer because the next call
-    // to `alloc_cb` will return the same unused pointer(`rbuffer_produced`
+    // to `alloc_cb` will return the same unused pointer (`rbuffer_produced`
    // won't be called)
    if (cnt == UV_ENOBUFS || cnt == 0) {
      return;
--- a/src/nvim/event/wstream.c
+++ b/src/nvim/event/wstream.c
@ -103,7 +103,7 @@ err:

 /// Creates a WBuffer object for holding output data. Instances of this
 /// object can be reused across Stream instances, and the memory is freed
-/// automatically when no longer needed(it tracks the number of references
+/// automatically when no longer needed (it tracks the number of references
 /// internally)
 ///
 /// @param data Data stored by the WBuffer
@ -111,7 +111,7 @@ err:
 /// @param refcount The number of references for the WBuffer. This will be used
 ///        by Stream instances to decide when a WBuffer should be freed.
 /// @param cb Pointer to function that will be responsible for freeing
-///        the buffer data(passing 'free' will work as expected).
+///        the buffer data (passing `xfree` will work as expected).
 /// @return The allocated WBuffer instance
 WBuffer *wstream_new_buffer(char *data, size_t size, size_t refcount, wbuffer_data_finalizer cb)
  FUNC_ATTR_NONNULL_ARG(1)
--- a/src/nvim/mbyte_defs.h
+++ b/src/nvim/mbyte_defs.h
@ -10,7 +10,7 @@ enum {
  /// character of up to 6 bytes, or one 16-bit character of up to three bytes
  /// plus six following composing characters of three bytes each.
  MB_MAXBYTES = 21,
-  /// max length of an unicode char
+  /// Maximum length of a Unicode character, excluding composing characters.
  MB_MAXCHAR = 6,
 };

--- a/src/nvim/os/input.c
+++ b/src/nvim/os/input.c
@ -351,8 +351,7 @@ static uint8_t check_multiclick(int code, int grid, int row, int col)
  return modifiers;
 }

-// Mouse event handling code(Extract row/col if available and detect multiple
-// clicks)
+/// Mouse event handling code (extract row/col if available and detect multiple clicks)
 static unsigned handle_mouse_event(const char **ptr, uint8_t *buf, unsigned bufsize)
 {
  int mouse_code = 0;
--- a/src/nvim/os/shell.c
+++ b/src/nvim/os/shell.c
@ -1117,8 +1117,8 @@ static void out_data_ring(char *output, size_t size)
 /// Continue to append data to last screen line.
 ///
 /// @param output       Data to append to screen lines.
-/// @param remaining    Size of data.
-/// @param new_line     If true, next data output will be on a new line.
+/// @param count        Size of data.
+/// @param eof          If true, there will be no more data output.
 static void out_data_append_to_screen(char *output, size_t *count, bool eof)
  FUNC_ATTR_NONNULL_ALL
 {
@ -1168,8 +1168,7 @@ static void out_data_cb(Stream *stream, RBuffer *buf, size_t count, void *data,
    rbuffer_consumed(buf, cnt);
  }

-  // Move remaining data to start of buffer, so the buffer can never
-  // wrap around.
+  // Move remaining data to start of buffer, so the buffer can never wrap around.
  rbuffer_reset(buf);
 }

--- a/src/nvim/po/ru.po
+++ b/src/nvim/po/ru.po
@ -4187,9 +4187,9 @@ msgid ""
 "&No\n"
 "&Cancel"
 msgstr ""
-"&Да\n"
-"&Нет\n"
-"О&тмена"
+"&Y Да\n"
+"&N Нет\n"
+"&C Отмена"

 #: ../message.c:3045
 msgid ""
--- a/test/README.md
+++ b/test/README.md
@ -252,7 +252,7 @@ by the semantic component they are testing.
 - _Functional tests_
  ([test/functional](https://github.com/neovim/neovim/tree/master/test/functional))
  are higher-level (plugins and user input) than unit tests; they are organized
-  by concept. 
+  by concept.
    - Try to find an existing `test/functional/*/*_spec.lua` group that makes
      sense, before creating a new one.

@ -276,9 +276,9 @@ the file).
 Configuration
 =============

-Test behaviour is affected by environment variables. Currently supported 
-(Functional, Unit, Benchmarks) (when Defined; when set to _1_; when defined, 
-treated as Integer; when defined, treated as String; when defined, treated as 
+Test behaviour is affected by environment variables. Currently supported
+(Functional, Unit, Benchmarks) (when Defined; when set to _1_; when defined,
+treated as Integer; when defined, treated as String; when defined, treated as
 Number; !must be defined to function properly):

 - `BUSTED_ARGS` (F) (U): arguments forwarded to `busted`.
--- a/test/old/testdir/test.sh
+++ b/test/old/testdir/test.sh
@ -58,7 +58,7 @@ check_core_dumps() {
 }

 check_logs() {
-  # Iterate through each log to remove an useless warning.
+  # Iterate through each log to remove a useless warning.
  # shellcheck disable=SC2044
  for log in $(find "${1}" -type f -name "${2}"); do
    sed -i "${log}" \
--- a/test/unit/helpers.lua
+++ b/test/unit/helpers.lua
@ -209,7 +209,7 @@ local function cimport(...)
      local new_cdefs = Set:new()
      for line in body:gmatch('[^\r\n]+') do
        line = trim(line)
-        -- give each #pragma pack an unique id, so that they don't get removed
+        -- give each #pragma pack a unique id, so that they don't get removed
        -- if they are inserted into the set
        -- (they are needed in the right order with the struct definitions,
        -- otherwise luajit has wrong memory layouts for the structs)