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

Merge branch 'main' of https://github.com/danymat/neogen

Browse Source
This commit is contained in:
Daniel Mathiot
2021-08-23 19:12:27 +02:00
parent ee1e1a491c e8a9a425be
commit 9ac072c50b
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -71,9 +71,11 @@ require('neogen').setup {
languages = {
lua = {
template = {
annotation_convention = "emmylua" -- for a full list of annotation_conventions, see supported-languages below
annotation_convention = "emmylua" -- for a full list of annotation_conventions, see supported-languages below,
... -- for more template configurations, see the language's configuration file in configurations/{lang}.lua
}
}
},
...
}
}
```
@@ -84,7 +86,7 @@ There is a list of supported languages and fields, with their annotation style
| Language | Annotation conventions | Supported fields |
|---|---|---|
| lua | Emmylua (`"emmylua"` | `@param`, `@varargs`, `@return` |
| lua | Emmylua (`"emmylua"`) | `@param`, `@varargs`, `@return` |
| python | Google docstrings (`"google_docstrings"`) | `Args`, `Attributes`, `Returns` |
| python | Numpydoc (`"numpydoc"`)| `Arguments`, `Attributes`, `Returns`|