diff --git a/doc/gopher.nvim.txt b/doc/gopher.nvim.txt index 7118e3c..d4a82d0 100644 --- a/doc/gopher.nvim.txt +++ b/doc/gopher.nvim.txt @@ -20,13 +20,15 @@ Table of Contents ------------------------------------------------------------------------------ *gopher.nvim-setup* - `gopher.setup` + `gopher.setup`({user_config}) Setup function. This method simply merges default configs with opts table. You can read more about configuration at |gopher.nvim-config| Calling this function is optional, if you ok with default settings. Look |gopher.nvim.config-defaults| Usage ~ `require("gopher").setup {}` (replace `{}` with your `config` table) +Parameters ~ +{user_config} gopher.Config ------------------------------------------------------------------------------ *gopher.nvim-install-deps* @@ -50,6 +52,10 @@ You can look at default options |gopher.nvim-config-defaults| local default_config = { --minidoc_replace_end + -- log level, you might consider using DEBUG or TRACE for degugging the plugin + ---@type number + log_level = vim.log.levels.INFO, + -- user specified paths to binaries ---@class gopher.ConfigCommand commands = { @@ -81,12 +87,6 @@ You can look at default options |gopher.nvim-config-defaults| Class ~ {gopher.Config} ------------------------------------------------------------------------------- - *config.setup()* - `config.setup`({user_config}) -Parameters ~ -{user_config} `(optional)` gopher.Config - ============================================================================== ------------------------------------------------------------------------------ diff --git a/lua/gopher/config.lua b/lua/gopher/config.lua index d457386..9c20843 100644 --- a/lua/gopher/config.lua +++ b/lua/gopher/config.lua @@ -75,6 +75,7 @@ local _config = default_config _config.___plugin_name = "gopher.nvim" ---@diagnostic disable-line: inject-field ---@param user_config? gopher.Config +---@private function config.setup(user_config) _config = vim.tbl_deep_extend("force", default_config, user_config or {}) end