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
2022-06-15 09:16:28 +00:00
parent 110c307ddf
commit 2286d51628
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/neogen.txt
View File

@@ -152,6 +152,9 @@ Parameters~
{opts} `(table)` Optional configs to change default behaviour of generation. {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. - {opts.type} `(string, default: "func")` Which type we are trying to use for generating annotations.
Currently supported: `func`, `class`, `type`, `file` Currently supported: `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.
- {opts.return_snippet} `boolean` if true, will return 3 values from the function call. - {opts.return_snippet} `boolean` if true, will return 3 values from the function call.
This option is useful if you want to get the snippet to use with a unsupported snippet engine This option is useful if you want to get the snippet to use with a unsupported snippet engine
Below are the returned values: Below are the returned values:
@@ -180,12 +183,16 @@ Feel free to submit a PR, I will be happy to help you !
We use semantic versioning ! (https://semver.org) We use semantic versioning ! (https://semver.org)
Here is the current Neogen version: Here is the current Neogen version:
> >
neogen.version = "2.6.0" neogen.version = "2.8.0"
< <
# Changelog~ # Changelog~
Note: We will only document `major` and `minor` versions, not `patch` ones. Note: We will only document `major` and `minor` versions, not `patch` ones.
## 2.8.0~
- Specify annotation convention on `generate()` method (see |neogen.generate()|)
## 2.7.0~
- Add support for `snippy` snippet engine ! (see |neogen-snippet-integration|)
## 2.6.0~ ## 2.6.0~
- Add support for placeholders in snippet insertion ! - Add support for placeholders in snippet insertion !
None: placeholders are automatically set when using a bundled snippet engine. None: placeholders are automatically set when using a bundled snippet engine.