docs: Fix google-style docstrings in duties.py#468
Conversation
|
Thanks @mushitoriami! I don't understand though, the Example section should definitely work, it should create an admonition. If I load the code with Griffe and parse the docstring, the section is correctly parsed as an admonition 🙃 So I don't understand yet why it's not rendered as such. |
|
Ah, right, I'm dog-fooding the |
|
@pawamoy Thanks for the comment. I've updated to set the style option. |
|
It looks like the CI failure is caused by |
|
Thanks! |
|
Actually, lets rather add some patterns to the function that infers style. Let me do that in another PR. Thanks again for the report! |
For reviewers
Description of the change
In the docstrings in
duties.py, there are someExample:occurrences, but these should beExamples:(https://mkdocstrings.github.io/griffe/reference/docstrings/#google-section-examples). This issue causes broken document format (https://mkdocstrings.github.io/griffe/guide/contributors/commands/#check-quality, https://mkdocstrings.github.io/griffe/guide/contributors/commands/#check-types ).