leigh/neogen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Daniel Mathiot
2021-08-23 08:50:07 +02:00
committed by GitHub
parent f6841b699a
commit 84920a1621
1 changed files with 2 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -64,10 +64,7 @@ There is a list of supported languages and fields, with their annotation style
| Language | Annotation conventions | Supported fields |
|---|---|---|
| lua | Emmylua | |
| | | `@param` |
| | | `@varargs` |
| | | `@return` |
| lua | Emmylua | `@param`, `@varargs`, `@return` |
## Usage
@@ -78,7 +75,7 @@ You can bind it to your keybind of choice, like so:
vim.api.nvim_set_keymap("n", "<Leader>ng", ":Neogen<CR>", {})
```
If you are inside a function, it'll generate the documentation for you with Emmylua annotation convention
It'll generate the annotations provided by neogen.
## GIFS