-
-
Notifications
You must be signed in to change notification settings - Fork 32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support "Keyword Arguments" sections in Google-style docstrings #88
Labels
feature
New feature or request
Comments
Adding for reference that napoleon supports it: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html#docstring-sections |
Thanks Note that the feature request is accepted, we just need time from the maintainers (me, probably) or a PR 😛 |
hahaha I see what you did there 👯 Anyway, I hacked a PR, will push soon. |
HacKanCuBa
added a commit
to HacKanCuBa/pytkdocs
that referenced
this issue
May 8, 2021
Add support for "Keyword Args" and "Keyword Arguments" sections for Google-style docstrings. Closes mkdocstrings#88.
HacKanCuBa
added a commit
to HacKanCuBa/pytkdocs
that referenced
this issue
May 8, 2021
Add support for "Keyword Args" and "Keyword Arguments" sections for Google-style docstrings. Closes mkdocstrings#88.
HacKanCuBa
added a commit
to HacKanCuBa/pytkdocs
that referenced
this issue
May 8, 2021
Add support for "Keyword Args" and "Keyword Arguments" sections for Google-style docstrings. Closes mkdocstrings#88.
HacKanCuBa
added a commit
to HacKanCuBa/pytkdocs
that referenced
this issue
May 10, 2021
Add support for "Keyword Args" and "Keyword Arguments" sections for Google-style docstrings. Closes mkdocstrings#88.
pawamoy
pushed a commit
that referenced
this issue
May 12, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem? Please describe.
Keyword sections is useful to document the possible contents of
**kwargs
. Without it, users must write keyword arguments documentation in theArguments
section, under the**kwargs
parameter, using plain Markdown, therefore not benefiting from the table template.Describe the solution you'd like
Support keyword arguments section in the google style parser.
Describe alternatives you've considered
As mentioned previously, an alternative is to document kwargs in the Arguments section, but this is a bit tedious to do it right.
Additional context
Only the Google-style parser is concerned by this feature request. Other issues will be needed for the other parsers, if needed.
Originally asked on mkdocstrings: mkdocstrings/mkdocstrings#205
The text was updated successfully, but these errors were encountered: