olexsmir/gopher.nvim
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs(config): update

Browse source
This commit is contained in:
Smirnov Oleksandr 2024-02-28 21:31:26 +02:00
parent 55a7307b78
commit 04eb2c3d76
2 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/gopher.nvim.txt
View file

@ -15,6 +15,9 @@ Table of Contents
============================================================================== ==============================================================================
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*gopher.nvim-config* *gopher.nvim-config*
config it is the place where you can configure the plugin.
also this is optional is you're ok with default settings.
You can look at default options |gopher.nvim-config-defaults|
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
Type ~ Type ~
@ -23,6 +26,7 @@ gopher.Config
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*gopher.nvim-config.ConfigGoTagTransform* *gopher.nvim-config.ConfigGoTagTransform*
Possible values for |gopher.Config|.gotag.transform: Possible values for |gopher.Config|.gotag.transform:
"snakecase" "GopherUser" -> "gopher_user" "snakecase" "GopherUser" -> "gopher_user"
"camelcase" "GopherUser" -> "gopherUser" "camelcase" "GopherUser" -> "gopherUser"
"lispcase" "GopherUser" -> "gopher-user" "lispcase" "GopherUser" -> "gopher-user"

4
lua/gopher/config.lua
View file

@ -1,5 +1,8 @@
---@toc_entry Configuration ---@toc_entry Configuration
---@tag gopher.nvim-config ---@tag gopher.nvim-config
---@text config it is the place where you can configure the plugin.
--- also this is optional is you're ok with default settings.
--- You can look at default options |gopher.nvim-config-defaults|
---@type gopher.Config ---@type gopher.Config
--minidoc_replace_start --minidoc_replace_start
@ -8,6 +11,7 @@ local config = {}
---@tag gopher.nvim-config.ConfigGoTagTransform ---@tag gopher.nvim-config.ConfigGoTagTransform
---@text Possible values for |gopher.Config|.gotag.transform: ---@text Possible values for |gopher.Config|.gotag.transform:
---
---@alias gopher.ConfigGoTagTransform ---@alias gopher.ConfigGoTagTransform
---| "snakecase" "GopherUser" -> "gopher_user" ---| "snakecase" "GopherUser" -> "gopher_user"
---| "camelcase" "GopherUser" -> "gopherUser" ---| "camelcase" "GopherUser" -> "gopherUser"