docs: add comment header to require("mason-lspconfig").setup_handlers() (#76)

1 files changed, 17 insertions, 0 deletions

diff --git a/lua/mason-lspconfig/init.lua b/lua/mason-lspconfig/init.lua
index 8682d2e8..276d41c4 100644
--- a/lua/mason-lspconfig/init.lua
+++ b/lua/mason-lspconfig/init.lua
@@ -107,6 +107,23 @@ function M.setup(config)
     require "mason-lspconfig.api.command"
 end
 
+---Register handlers that will be called when a server is ready to be set up (i.e. is installed).
+---When this function is first called, the appropriate handler will be called for each installed server.
+---When a new server is installed, the appropriate handler for that server will be called (this allows you for example to set up-new servers without restarting Neovim).
+---The default handler is provided as the first value in the table argument.
+---
+---Example:
+---```lua
+---    require("mason-lspconfig").setup_handlers {
+---        function (server_name)
+---            -- default handler
+---            require("lspconfig")[server_name].setup {}
+---        end,
+---        ["rust_analyzer"] = function ()
+---            require("rust-tools").setup {}
+---        end
+---    }
+---```
 ---@param handlers table<string, fun(server_name: string)>
 function M.setup_handlers(handlers)
     local default_handler = Optional.of_nilable(handlers[1])