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

[docgen] Update doc/neogen.txt

Browse Source 
skip-checks: true
This commit is contained in:
github-actions
2024-08-22 08:41:06 +00:00
parent d242dd3462
commit e932ba918b
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/neogen.txt
View File

@@ -148,7 +148,7 @@ For example, if you are inside a function, and called `generate({ type = "func"
Neogen will go until the start of the function and start annotating for you. Neogen will go until the start of the function and start annotating for you.
Parameters ~ Parameters ~
{opts} `(table)` Optional configs to change default behaviour of generation. {opts} `(optional)` `(table)` Optional configs to change default behaviour of generation.
- {opts.type} `(string, default: "any")` Which type we are trying to use for generating annotations. - {opts.type} `(string, default: "any")` Which type we are trying to use for generating annotations.
Currently supported: `any`, `func`, `class`, `type`, `file` Currently supported: `any`, `func`, `class`, `type`, `file`
- {opts.annotation_convention} `(table)` convention to use for generating annotations. - {opts.annotation_convention} `(table)` convention to use for generating annotations.