From 04eb2c3d764f2e81bbeea1cb95af9064036598f1 Mon Sep 17 00:00:00 2001 From: Smirnov Oleksandr Date: Wed, 28 Feb 2024 21:31:26 +0200 Subject: [PATCH] docs(config): update --- doc/gopher.nvim.txt | 4 ++++ lua/gopher/config.lua | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/doc/gopher.nvim.txt b/doc/gopher.nvim.txt index 74a1b0b..4b3acd9 100644 --- a/doc/gopher.nvim.txt +++ b/doc/gopher.nvim.txt @@ -15,6 +15,9 @@ Table of Contents ============================================================================== ------------------------------------------------------------------------------ *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 ~ @@ -23,6 +26,7 @@ gopher.Config ------------------------------------------------------------------------------ *gopher.nvim-config.ConfigGoTagTransform* Possible values for |gopher.Config|.gotag.transform: + "snakecase" "GopherUser" -> "gopher_user" "camelcase" "GopherUser" -> "gopherUser" "lispcase" "GopherUser" -> "gopher-user" diff --git a/lua/gopher/config.lua b/lua/gopher/config.lua index e6e25b7..f1e4af1 100644 --- a/lua/gopher/config.lua +++ b/lua/gopher/config.lua @@ -1,5 +1,8 @@ ---@toc_entry Configuration ---@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 --minidoc_replace_start @@ -8,6 +11,7 @@ local config = {} ---@tag gopher.nvim-config.ConfigGoTagTransform ---@text Possible values for |gopher.Config|.gotag.transform: +--- ---@alias gopher.ConfigGoTagTransform ---| "snakecase" "GopherUser" -> "gopher_user" ---| "camelcase" "GopherUser" -> "gopherUser"