docs: correct public source documentation

Author: mehalter

README.md

@@ -43,10 +43,10 @@ require("astrolsp").setup {
 
 ## ⚙️ Configuration
 
-**AstroLSP** comes with the no defaults, but can be configured fully through the `opts` table in lazy or through calling `require("astrolsp").setup({})`. Here are descriptions of the options and some example usages:
+**AstroLSP** defaults to CodeLens refresh, semantic token highlighting, enabled format on save, and a 10-second file-operation timeout; file-operation methods are disabled until configured. Configure it through the `opts` table in lazy or by calling `require("astrolsp").setup({})`. Here are descriptions of the options and some example usages:
 
 ```lua
----@type AstroLSPConfig
+---@type AstroLSPOpts
 local opts = {
   -- Configuration table of features provided by AstroLSP
   features = {

lua/astrolsp/config.lua

@@ -48,11 +48,11 @@
 ---@field filter (fun(client):boolean)? a function for doing a custom formatting filter based on LSP client name
 
 ---@class AstroLSPFileOperationsOperationsOpts
----@field willCreate boolean? enable/disable pre-create file notifications
----@field willDelete boolean? enable/disable pre-create file notifications
----@field willRename boolean? enable/disable pre-rename file notifications
+---@field willCreate boolean? enable/disable pre-create file requests
+---@field willDelete boolean? enable/disable pre-delete file requests
+---@field willRename boolean? enable/disable pre-rename file requests
 ---@field didCreate boolean? enable/disable post-create file notifications
----@field didDelete boolean? enable/disable post-create file notifications
+---@field didDelete boolean? enable/disable post-delete file notifications
 ---@field didRename boolean? enable/disable post-rename file notifications
 
 ---@class AstroLSPFileOperationsOpts
@@ -166,12 +166,12 @@
 ---  timeout = 10000,
 ---  -- fully disable/enable file operation methods
 ---  operations = {
----   willRenameFiles = true,
----   didRenameFiles = true,
----   willCreateFiles = true,
----   didCreateFiles = true,
----   willDeleteFiles = true,
----   didDeleteFiles = true,
+---   willRename = true,
+---   didRename = true,
+---   willCreate = true,
+---   didCreate = true,
+---   willDelete = true,
+---   didDelete = true,
 ---  }
 --- }
 ---```

lua/astrolsp/file_operations.lua

@@ -124,7 +124,7 @@ local function getWorkspaceEdit(client, req, params, timeout)
   if resp and resp.result then return resp.result end
 end
 
---- Notify LSP clients that file(s) are going to be created
+--- Request workspace edits from LSP clients before file(s) are created
 ---@param fnames string|string[] a file or list of files that will be created
 function M.willCreateFiles(fnames)
   local config = get_config()
@@ -148,7 +148,7 @@ function M.willCreateFiles(fnames)
   end
 end
 
---- Notify LSP clients that file(s) are going to be deleted
+--- Request workspace edits from LSP clients before file(s) are deleted
 ---@param fnames string|string[] a file or list of files that will be deleted
 function M.willDeleteFiles(fnames)
   local config = get_config()
@@ -172,7 +172,7 @@ function M.willDeleteFiles(fnames)
   end
 end
 
---- Notify LSP clients that file(s) are going to be renamed
+--- Request workspace edits from LSP clients before file(s) are renamed
 ---@param renames AstroLSPFileOperationsRename|AstroLSPFileOperationsRename[] a table or list of tables of files that will be renamed
 function M.willRenameFiles(renames)
   local config = get_config()

lua/astrolsp/toggles.lua

@@ -15,7 +15,7 @@ local function ui_notify(silent, ...) return not silent and vim.notify(...) end
 local function bool2str(bool) return bool and "on" or "off" end
 
 --- Toggle auto format
----@param silent? boolean if true then don't sent a notification
+---@param silent? boolean if true then don't send a notification
 function M.autoformat(silent)
   local format_on_save = get_config().formatting.format_on_save --[[@as AstroLSPFormatOnSaveOpts]]
   format_on_save.enabled = not format_on_save.enabled
@@ -24,7 +24,7 @@ end
 
 --- Toggle buffer local auto format
 ---@param bufnr? integer The buffer to toggle the autoformatting of, default the current buffer
----@param silent? boolean if true then don't sent a notification
+---@param silent? boolean if true then don't send a notification
 function M.buffer_autoformat(bufnr, silent)
   bufnr = bufnr or 0
   local old_val = vim.b[bufnr].autoformat
@@ -38,7 +38,7 @@ end
 
 --- Toggle buffer LSP inlay hints
 ---@param bufnr? integer the buffer to toggle the clients on
----@param silent? boolean if true then don't sent a notification
+---@param silent? boolean if true then don't send a notification
 function M.buffer_inlay_hints(bufnr, silent)
   if vim.lsp.inlay_hint then
     local filter = { bufnr = bufnr or 0 }
@@ -48,7 +48,7 @@ function M.buffer_inlay_hints(bufnr, silent)
 end
 
 --- Toggle global LSP inlay hints
----@param silent? boolean if true then don't sent a notification
+---@param silent? boolean if true then don't send a notification
 function M.inlay_hints(silent)
   if vim.lsp.inlay_hint then
     vim.lsp.inlay_hint.enable(not vim.lsp.inlay_hint.is_enabled())
@@ -58,7 +58,7 @@ end
 
 --- Toggle buffer semantic token highlighting for all language servers that support it
 ---@param bufnr? integer the buffer to toggle the clients on
----@param silent? boolean if true then don't sent a notification
+---@param silent? boolean if true then don't send a notification
 function M.buffer_semantic_tokens(bufnr, silent)
   bufnr = bufnr or 0
   if vim.lsp.semantic_tokens.enable then
@@ -83,7 +83,7 @@ function M.buffer_semantic_tokens(bufnr, silent)
 end
 
 --- Toggle global semantic token highlighting for all language servers that support it
----@param silent? boolean if true then don't sent a notification
+---@param silent? boolean if true then don't send a notification
 function M.semantic_tokens(silent)
   if not vim.lsp.semantic_tokens.enable then
     ui_notify(silent, "Only available in Neovim v0.12+", vim.log.levels.WARN)
@@ -96,7 +96,7 @@ end
 
 --- Toggle buffer codelens
 ---@param bufnr? integer the buffer to toggle the clients on
----@param silent? boolean if true then don't sent a notification
+---@param silent? boolean if true then don't send a notification
 function M.buffer_codelens(bufnr, silent)
   bufnr = bufnr or 0
   if not vim.lsp.codelens.enable then
@@ -108,7 +108,7 @@ function M.buffer_codelens(bufnr, silent)
 end
 
 --- Toggle global codelens
----@param silent? boolean if true then don't sent a notification
+---@param silent? boolean if true then don't send a notification
 function M.codelens(silent)
   -- TODO: remove check when dropping support for Neovim v0.11
   if vim.lsp.codelens.enable then
@@ -123,7 +123,7 @@ function M.codelens(silent)
 end
 
 --- Toggle automatic signature help
----@param silent? boolean if true then don't sent a notification
+---@param silent? boolean if true then don't send a notification
 function M.signature_help(silent)
   local config = get_config()
   config.features.signature_help = not config.features.signature_help
@@ -132,7 +132,7 @@ end
 
 --- Toggle buffer local automatic signature help
 ---@param bufnr? integer The buffer to toggle the auto signature help of, default the current buffer
----@param silent? boolean if true then don't sent a notification
+---@param silent? boolean if true then don't send a notification
 function M.buffer_signature_help(bufnr, silent)
   bufnr = bufnr or 0
   local config = get_config()