Skip to content

Commit

Permalink
docs: Update note about supported docstring options
Browse files Browse the repository at this point in the history
  • Loading branch information
thatlittleboy authored and pawamoy committed Feb 26, 2022
1 parent d8d7b70 commit 5867162
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/handlers/overview.md
Expand Up @@ -80,8 +80,8 @@ dependencies = [
except for the `restructured-text` style which is renamed `sphinx`.
Numpy-style is now built-in, so you can stop depending on `pytkdocs[numpy-style]`
or `docstring_parser`.
- `docstring_options` is implemented, and used as before, however none
of the provided parsers accept any option yet.
- `docstring_options` is implemented, and used as before.
Refer to the [`griffe` documentation](https://mkdocstrings.github.io/griffe/docstrings/#parsing-options) for the updated list of supported docstring options.
- `new_path_syntax` is irrelevant now. If you were setting it to True,
remove the option and replace every colon (`:`) in your autodoc identifiers
by dots (`.`).
Expand Down

0 comments on commit 5867162

Please sign in to comment.