Skip to content

Commit b6587ae

Browse files
authored
fix: typos in lua/vim docs (#453)
Fix some typos. Since this involves breaking changes such as changing the option name, I think it would be better to leave the mistyped option name and mark it as deprecated in LuaLS. e.g. ### `lua/haskell-tools/config/internal.lua` ```lua -- .... exception = true, }, }, ---@deprecated -- add it excplicitFixity = { globalOn = true }, explicitFixity = { globalOn = true }, gadt = { globalOn = true }, ['ghcide-code-actions-bindings'] = { globalOn = true }, ['ghcide-code-actions-fill-holes'] = { globalOn = true }, --- .... ``` e6e38c0
1 parent de30baf commit b6587ae

File tree

12 files changed

+13
-13
lines changed

12 files changed

+13
-13
lines changed

doc/haskell-tools.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ haskell-tools.hover.Opts *haskell-tools.hover.Opts*
126126
{stylize_markdown?} (boolean)
127127
(default: `false`) The builtin LSP client's default behaviour is to stylize markdown.
128128
Setting this option to false sets the file type to markdown
129-
and enables treesitter syntax highligting for Haskell snippets if nvim-treesitter is installed.
129+
and enables treesitter syntax highlighting for Haskell snippets if nvim-treesitter is installed.
130130
{auto_focus?} (boolean)
131131
(default: `false`) Whether to automatically switch to the hover window.
132132

lua/haskell-tools/commands.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ local function register_subcommand_tbl(name, subcmd_tbl)
8181
vim.notify(
8282
([[
8383
Haskell %s: Expected subcommand.
84-
Avaiable subcommands:
84+
Available subcommands:
8585
%s
8686
]]):format(name, table.concat(vim.tbl_keys(subcmd_tbl), ', ')),
8787
vim.log.levels.ERROR

lua/haskell-tools/config/init.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ vim.g.haskell_tools = vim.g.haskell_tools
9494
---
9595
---(default: `false`) The builtin LSP client's default behaviour is to stylize markdown.
9696
---Setting this option to false sets the file type to markdown
97-
---and enables treesitter syntax highligting for Haskell snippets if nvim-treesitter is installed.
97+
---and enables treesitter syntax highlighting for Haskell snippets if nvim-treesitter is installed.
9898
---@field stylize_markdown? boolean
9999
---
100100
---(default: `false`) Whether to automatically switch to the hover window.

lua/haskell-tools/config/internal.lua

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ local HTDefaultConfig = {
7373
{ '', 'FloatBorder' },
7474
{ '', 'FloatBorder' },
7575
},
76-
---@type boolean (default: `false`) The builtin LSP client's default behaviour is to stylize markdown. Setting this option to false sets the file type to markdown and enables treesitter syntax highligting for Haskell snippets if nvim-treesitter is installed.
76+
---@type boolean (default: `false`) The builtin LSP client's default behaviour is to stylize markdown. Setting this option to false sets the file type to markdown and enables treesitter syntax highlighting for Haskell snippets if nvim-treesitter is installed.
7777
stylize_markdown = false,
7878
---@type boolean (default: `false`) Whether to automatically switch to the hover window.
7979
auto_focus = false,
@@ -190,7 +190,7 @@ local HTDefaultConfig = {
190190
exception = true,
191191
},
192192
},
193-
excplicitFixity = { globalOn = true },
193+
explicitFixity = { globalOn = true },
194194
gadt = { globalOn = true },
195195
['ghcide-code-actions-bindings'] = { globalOn = true },
196196
['ghcide-code-actions-fill-holes'] = { globalOn = true },

lua/haskell-tools/health.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ local external_dependencies = {
127127
return not hoogle_mode or hoogle_mode ~= 'telescope-web'
128128
end,
129129
url = '[curl](https://curl.se/)',
130-
info = 'Required for "telescope-web" hoogle seach mode.',
130+
info = 'Required for "telescope-web" hoogle search mode.',
131131
},
132132
{
133133
name = 'haskell-debug-adapter',

lua/haskell-tools/hoogle/helpers.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ local entry_display = deps.require_telescope('telescope.pickers.entry_display')
1919
---@class haskell-tools.hoogle.Helpers
2020
local Helpers = {}
2121

22-
---@param buf number the telescope buffebuffer numberr
22+
---@param buf number the telescope buffebuffer number
2323
---@param map fun(mode:string,keys:string,action:function) callback for creating telescope keymaps
2424
---@return boolean
2525
function Helpers.hoogle_attach_mappings(buf, map)

lua/haskell-tools/hoogle/web.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ end
3535
---@class haskell-tools.hoogle.web-search.Opts
3636
---@field base_url string|nil The base URL of the hoogle server
3737
---@field scope string|nil The scope of the search
38-
---@field json boolean|nil Whather to request JSON enocded results
38+
---@field json boolean|nil Whether to request JSON encoded results
3939

4040
---Build a Hoogle request URL
4141
---@param search_term string

lua/haskell-tools/lsp/helpers.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ function LspHelpers.get_active_haskell_clients(bufnr)
2626
end
2727

2828
---@param bufnr number the buffer to get clients for
29-
---@return vim.lsp.Client[] cabal_clinets
29+
---@return vim.lsp.Client[] cabal_clients
3030
---@see util.get_clients
3131
function LspHelpers.get_active_cabal_clients(bufnr)
3232
return LspHelpers.get_clients { bufnr = bufnr, name = LspHelpers.cabal_client_name }

lua/haskell-tools/lsp/hover.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ function hover.on_hover(_, result, ctx, config)
265265
close_hover()
266266
end
267267
table.insert(_state.commands, references_action)
268-
create_plug_mapping('Referenes', references_action, current_bufnr)
268+
create_plug_mapping('References', references_action, current_bufnr)
269269
::SkipDefinition::
270270
if found_type_definition then
271271
goto SkipTypeDefinition

lua/haskell-tools/lsp/init.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ end
3131
---A workaround for #48:
3232
---Some plugins that add LSP client capabilities which are not built-in to neovim
3333
---(like nvim-ufo and nvim-lsp-selection-range) cause error messages, because
34-
---haskell-language-server falsly advertises those server_capabilities for cabal files.
34+
---haskell-language-server falsely advertises those server_capabilities for cabal files.
3535
---@param client vim.lsp.Client
3636
---@return nil
3737
local function fix_cabal_client(client)

0 commit comments

Comments
 (0)