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

doc: generate function: add any to opts

Browse Source 
Signed-off-by: Sabu Siyad <hello@ssiyad.com>
This commit is contained in:
Sabu Siyad
2023-01-03 00:21:47 +05:30
parent a7f0e7051e
commit aae0d3062b
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
lua/neogen/init.lua
View File

@@ -148,8 +148,8 @@ neogen.configuration = {
--- Neogen will go until the start of the function and start annotating for you.
---
---@param opts table Optional configs to change default behaviour of generation.
--- - {opts.type} `(string, default: "func")` Which type we are trying to use for generating annotations.
--- Currently supported: `func`, `class`, `type`, `file`
--- - {opts.type} `(string, default: "any")` Which type we are trying to use for generating annotations.
--- Currently supported: `any`, `func`, `class`, `type`, `file`
--- - {opts.annotation_convention} `(table)` convention to use for generating annotations.
--- This is language specific. For example, `generate({ annotation_convention = { python = 'numpydoc' } })`
--- If no convention is specified for a specific language, it'll use the default annotation convention for the language.