diff --git a/doc/neogen.txt b/doc/neogen.txt index aa7d940..f8b3b77 100644 --- a/doc/neogen.txt +++ b/doc/neogen.txt @@ -152,6 +152,9 @@ Parameters~ {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.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. This option is useful if you want to get the snippet to use with a unsupported snippet engine 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) Here is the current Neogen version: > - neogen.version = "2.6.0" + neogen.version = "2.8.0" < # Changelog~ 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~ - Add support for placeholders in snippet insertion ! None: placeholders are automatically set when using a bundled snippet engine.