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

Merge pull request #7 from cryptomilk/asn-readme

Browse Source 
README: Suggest to use noremap and silent for key bindings
This commit is contained in:
Daniel Mathiot
2021-08-27 13:36:37 +02:00
committed by GitHub
parent 80383b7004 1ad80a85ee
commit 4e4c7da587
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -53,7 +53,8 @@ require('neogen').generate()
You can bind it to your keybind of choice, like so: You can bind it to your keybind of choice, like so:
```lua ```lua
vim.api.nvim_set_keymap("n", "<Leader>nf", ":lua require('neogen').generate()<CR>", {}) local opts = { noremap = true, silent = true }
vim.api.nvim_set_keymap("n", "<Leader>nf", ":lua require('neogen').generate()<CR>", opts)
``` ```
Calling the `generate` function without any parameters will try to generate annotations for the current function. Calling the `generate` function without any parameters will try to generate annotations for the current function.
@@ -69,7 +70,8 @@ require('neogen').generate({
For example, I can add an other keybind to generate class annotations: For example, I can add an other keybind to generate class annotations:
```lua ```lua
vim.api.nvim_set_keymap("n", "<Leader>nc", ":lua require('neogen').generate({ type = 'class' })<CR>", {}) local opts = { noremap = true, silent = true }
vim.api.nvim_set_keymap("n", "<Leader>nc", ":lua require('neogen').generate({ type = 'class' })<CR>", opts)
``` ```