docs: regen

This commit is contained in:
Smirnov Oleksandr 2024-05-03 21:45:39 +03:00
parent 9ba98a1815
commit 4a7f915e7f
2 changed files with 8 additions and 7 deletions

View file

@ -20,13 +20,15 @@ Table of Contents
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*gopher.nvim-setup* *gopher.nvim-setup*
`gopher.setup` `gopher.setup`({user_config})
Setup function. This method simply merges default configs with opts table. Setup function. This method simply merges default configs with opts table.
You can read more about configuration at |gopher.nvim-config| 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| Calling this function is optional, if you ok with default settings. Look |gopher.nvim.config-defaults|
Usage ~ Usage ~
`require("gopher").setup {}` (replace `{}` with your `config` table) `require("gopher").setup {}` (replace `{}` with your `config` table)
Parameters ~
{user_config} gopher.Config
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*gopher.nvim-install-deps* *gopher.nvim-install-deps*
@ -50,6 +52,10 @@ You can look at default options |gopher.nvim-config-defaults|
local default_config = { local default_config = {
--minidoc_replace_end --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 -- user specified paths to binaries
---@class gopher.ConfigCommand ---@class gopher.ConfigCommand
commands = { commands = {
@ -81,12 +87,6 @@ You can look at default options |gopher.nvim-config-defaults|
Class ~ Class ~
{gopher.Config} {gopher.Config}
------------------------------------------------------------------------------
*config.setup()*
`config.setup`({user_config})
Parameters ~
{user_config} `(optional)` gopher.Config
============================================================================== ==============================================================================
------------------------------------------------------------------------------ ------------------------------------------------------------------------------

View file

@ -75,6 +75,7 @@ local _config = default_config
_config.___plugin_name = "gopher.nvim" ---@diagnostic disable-line: inject-field _config.___plugin_name = "gopher.nvim" ---@diagnostic disable-line: inject-field
---@param user_config? gopher.Config ---@param user_config? gopher.Config
---@private
function config.setup(user_config) function config.setup(user_config)
_config = vim.tbl_deep_extend("force", default_config, user_config or {}) _config = vim.tbl_deep_extend("force", default_config, user_config or {})
end end