From 829d337055e30646cb957176ed64472120274684 Mon Sep 17 00:00:00 2001 From: Oleksandr Smirnov Date: Sun, 23 Mar 2025 00:55:46 +0200 Subject: [PATCH] docs: update --- doc/gopher.nvim.txt | 23 +++++++++++------------ lua/gopher/impl.lua | 5 ++--- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/doc/gopher.nvim.txt b/doc/gopher.nvim.txt index 19bc583..3d653ca 100644 --- a/doc/gopher.nvim.txt +++ b/doc/gopher.nvim.txt @@ -8,15 +8,15 @@ gopher.nvim is a minimalistic plugin for Go development in Neovim written in Lua It's not an LSP tool, the main goal of this plugin is add go tooling support in Neovim. Table of Contents - Setup |gopher.nvim-setup()| - Install dependencies |gopher.nvim-dependencies| - Config |gopher.nvim-config| - Commands |gopher.nvim-commands| - Modify struct tags |gopher.nvim-struct-tags| - Auto implementation of interface methods |gopher.nvim-impl| - Generating unit tests boilerplate |gopher.nvim-gotests| - Iferr |gopher.nvim-iferr| - Generate comments |gopher.nvim-comments| + Setup..................................................|gopher.nvim-setup()| + Install dependencies..............................|gopher.nvim-dependencies| + Config..................................................|gopher.nvim-config| + Commands..............................................|gopher.nvim-commands| + Modify struct tags.................................|gopher.nvim-struct-tags| + Auto implementation of interface methods..................|gopher.nvim-impl| + Generating unit tests boilerplate......................|gopher.nvim-gotests| + Iferr....................................................|gopher.nvim-iferr| + Generate comments.....................................|gopher.nvim-comments| ------------------------------------------------------------------------------ *gopher.nvim-setup()* @@ -141,10 +141,9 @@ Example: ------------------------------------------------------------------------------ *gopher.nvim-impl* -impl is utilizing the `impl` tool to generate method stubs for interfaces. +Integration of `impl` tool to generate method stubs for interfaces. Usage ~ - 1. Automatically implement an interface for a struct: - Place your cursor on the struct where you want to implement the interface. - Run `:GoImpl io.Reader` @@ -218,4 +217,4 @@ Usage ~ Set cursor on line with function/method/struct/etc and run `:GoCmt` to generate a comment. - vim:tw=78:ts=8:noet:ft=help:norl: + vim:tw=78:ts=8:noet:ft=help:norl: \ No newline at end of file diff --git a/lua/gopher/impl.lua b/lua/gopher/impl.lua index d78bb5e..702d58e 100644 --- a/lua/gopher/impl.lua +++ b/lua/gopher/impl.lua @@ -1,10 +1,9 @@ ---@toc_entry Auto implementation of interface methods ---@tag gopher.nvim-impl ---@text ---- impl is utilizing the `impl` tool to generate method stubs for interfaces. +--- Integration of `impl` tool to generate method stubs for interfaces. --- ----@usage ---- 1. Automatically implement an interface for a struct: +---@usage 1. Automatically implement an interface for a struct: --- - Place your cursor on the struct where you want to implement the interface. --- - Run `:GoImpl io.Reader` --- - This will automatically determine the receiver and implement the `io.Reader` interface.