docs: misc

Co-authored-by: David Pedersen <[email protected]> Co-authored-by: Gregory Anders <[email protected]> Co-authored-by: Leo Schlosser <[email protected]> Co-authored-by: zeertzjq <[email protected]>
badfilms · Oct 23, 2024 · 3a86b60 · 3a86b60
1 parent f6f2334
commit 3a86b60
Show file tree

Hide file tree

Showing 12 changed files with 21 additions and 25 deletions.
diff --git a/.github/scripts/install_deps.sh b/.github/scripts/install_deps.sh
@@ -18,7 +18,7 @@ if [[ $os == Linux ]]; then
     DEFAULT_CLANG_VERSION=$(echo |  clang -dM -E - | grep __clang_major | awk '{print $3}')
     CLANG_VERSION=20
     if ((DEFAULT_CLANG_VERSION >= CLANG_VERSION)); then
-      echo "Default clang version is $DEFAULT_CLANG_VERSION, which equal or larger than wanted version $CLANG_VERSION. Aborting!"
+      echo "Default clang version is $DEFAULT_CLANG_VERSION, which is equal or larger than wanted version $CLANG_VERSION. Aborting!"
       exit 1
     fi
 

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -132,8 +132,8 @@ message(STATUS "CMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}")
 set_default_buildtype(Debug)
 get_property(isMultiConfig GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
 if(NOT isMultiConfig)
-  # Unlike build dependencies in cmake.deps, we assume we want dev dependencies
-  # such as Uncrustify to always be built with Release.
+  # Unlike build dependencies in cmake.deps, we want dev dependencies such as
+  # Uncrustify to always be built with Release.
   list(APPEND DEPS_CMAKE_ARGS -D CMAKE_BUILD_TYPE=Release)
 endif()
 

diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
diff --git a/runtime/doc/dev_style.txt b/runtime/doc/dev_style.txt
@@ -64,9 +64,8 @@ Symbols:
   - `extern` variables (including the `EXTERN` macro)
 
 Non-symbols:
-  - macros, i.e. `#define`.
-  - static inline functions, but only if its function declaration has a
-    `REAL_FATTR_ALWAYS_INLINE` attribute.
+  - macros, i.e. `#define`
+  - static inline functions with the `FUNC_ATTR_ALWAYS_INLINE` attribute
   - typedefs
   - structs
   - enums

diff --git a/runtime/doc/faq.txt b/runtime/doc/faq.txt
@@ -189,7 +189,7 @@ Other hints:
 
 - The python `neovim` module was renamed to `pynvim` (long ago).
 - If you're using pyenv or virtualenv for the `pynvim` module
-    https://pypi.python.org/pypi/pynvim/, you must set `g:python3_host_prog` to
+    https://pypi.org/project/pynvim/, you must set `g:python3_host_prog` to
     the virtualenv's interpreter path.
 - Read |provider-python|.
 - Be sure you have the latest version of the `pynvim` Python module: >bash

diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt
@@ -542,10 +542,10 @@ LspDetach                                                          *LspDetach*
 
         -- Remove the autocommand to format the buffer on save, if it exists
         if client.supports_method('textDocument/formatting') then
-            vim.api.nvim_clear_autocmds({
-                event = 'BufWritePre',
-                buffer = args.buf,
-            })
+          vim.api.nvim_clear_autocmds({
+            event = 'BufWritePre',
+            buffer = args.buf,
+          })
         end
       end,
     })
@@ -867,9 +867,9 @@ start({config}, {opts})                                      *vim.lsp.start()*
       |vim.lsp.start_client()|.
     • `root_dir` path to the project root. By default this is used to decide
       if an existing client should be re-used. The example above uses
-      |vim.fs.root()| and |vim.fs.dirname()| to detect the root by traversing
-      the file system upwards starting from the current directory until either
-      a `pyproject.toml` or `setup.py` file is found.
+      |vim.fs.root()| to detect the root by traversing the file system upwards
+      starting from the current directory until either a `pyproject.toml` or
+      `setup.py` file is found.
     • `workspace_folders` list of `{ uri:string, name: string }` tables
       specifying the project root folders used by the language server. If
       `nil` the property is derived from `root_dir` for convenience.

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
@@ -235,9 +235,9 @@ end
 --- - `name` arbitrary name for the LSP client. Should be unique per language server.
 --- - `cmd` command string[] or function, described at |vim.lsp.start_client()|.
 --- - `root_dir` path to the project root. By default this is used to decide if an existing client
----   should be re-used. The example above uses |vim.fs.root()| and |vim.fs.dirname()| to detect
----   the root by traversing the file system upwards starting from the current directory until
----   either a `pyproject.toml` or `setup.py` file is found.
+---   should be re-used. The example above uses |vim.fs.root()| to detect the root by traversing
+---   the file system upwards starting from the current directory until either a `pyproject.toml`
+---   or `setup.py` file is found.
 --- - `workspace_folders` list of `{ uri:string, name: string }` tables specifying the project root
 ---   folders used by the language server. If `nil` the property is derived from `root_dir` for
 ---   convenience.

diff --git a/runtime/lua/vim/provider/health.lua b/runtime/lua/vim/provider/health.lua
@@ -449,7 +449,7 @@ end
 --- Get the latest Nvim Python client (pynvim) version from PyPI.
 local function latest_pypi_version()
   local pypi_version = 'unable to get pypi response'
-  local pypi_response = download('https://pypi.python.org/pypi/pynvim/json')
+  local pypi_response = download('https://pypi.org/pypi/pynvim/json')
   if pypi_response ~= '' then
     local pcall_ok, output = pcall(vim.fn.json_decode, pypi_response)
     if not pcall_ok then

diff --git a/scripts/gen_help_html.lua b/scripts/gen_help_html.lua
@@ -1294,7 +1294,7 @@ function M.gen(help_dir, to_dir, include, commit, parser_path)
   end, 'valid directory')
   vim.validate('to_dir', to_dir, 'string')
   vim.validate('include', include, 'table', true)
-  vim.validate('commit', commit, 'sring', true)
+  vim.validate('commit', commit, 'string', true)
   vim.validate('parser_path', parser_path, function(f)
     return vim.fn.filereadable(vim.fs.normalize(f)) == 1
   end, true, 'valid vimdoc.{so,dll} filepath')

diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
@@ -6406,7 +6406,7 @@ M.funcs = {
     base = 1,
     desc = [=[
       {expr1} must be a |List|, |String|, |Blob| or |Dictionary|.
-      When {expr1} is a |List|| or |Dictionary|, replace each
+      When {expr1} is a |List| or |Dictionary|, replace each
       item in {expr1} with the result of evaluating {expr2}.
       For a |Blob| each byte is replaced.
       For a |String|, each character, including composing

diff --git a/src/nvim/mbyte.c b/src/nvim/mbyte.c
@@ -454,9 +454,6 @@ static bool prop_is_emojilike(const utf8proc_property_t *prop)
 /// Is only correct for characters >= 0x80.
 /// When p_ambw is "double", return 2 for a character with East Asian Width
 /// class 'A'(mbiguous).
-///
-/// @note Tables `doublewidth` and `ambiguous` are generated by
-///       gen_unicode_tables.lua, which must be manually invoked as needed.
 int utf_char2cells(int c)
 {
   if (c < 0x80) {