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>

.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)
 

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`.

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

INSTALL.md

@@ -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
 

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
     ""

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

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.
 

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

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

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

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. **
 
@@ -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,7 +565,7 @@ 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
@@ -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
 

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

src/nvim/event/wstream.c

@@ -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)

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,
 };
 

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;

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);
 }
 

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 ""

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}" \

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)