Add ldoc in README

This commit is contained in:
Daniel Mathiot
2021-08-29 20:00:20 +02:00
parent 518515be3e
commit 294ed7c1fa

View File

@@ -161,7 +161,7 @@ There is a list of supported languages and fields, with their annotation style
| Language | Annotation conventions | Supported fields | | Language | Annotation conventions | Supported fields |
|---|---|---| |---|---|---|
| lua | | | | lua | | |
| | [Emmylua](https://emmylua.github.io/) (`"emmylua"`) | `@param`, `@varargs`, `@return`, `@class`, `@type` | | | [Emmylua](https://emmylua.github.io/), [Ldoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html) (`"emmylua"`, `"ldoc"`) | `@param`, `@varargs`, `@return`, `@class`, `@type` |
| python | | | | python | | |
| | [Google docstrings](https://google.github.io/styleguide/pyguide.html) (`"google_docstrings"`) | `Args`, `Attributes`, `Returns` | | | [Google docstrings](https://google.github.io/styleguide/pyguide.html) (`"google_docstrings"`) | `Args`, `Attributes`, `Returns` |
| | [Numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) (`"numpydoc"`)| `Arguments`, `Attributes`, `Returns`| | | [Numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) (`"numpydoc"`)| `Arguments`, `Attributes`, `Returns`|