Skip to content
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

Fix #9648: autodoc: *args and **kwargs entries are duplicated #10451

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented May 15, 2022

Feature or Bugfix

  • Bugfix

Purpose

In basic usage of autodoc (docstring), `args` and `kwargs` arguments
are marked up without stars.  But numpydoc style recommends to mark
them up with stars.

This adds support for starred arguments in docstrings to
`autodoc_typehints` feature.
@tk0miya tk0miya force-pushed the 9648_autodoc_typehints_description_and_stared_args branch from 294617a to 06a9139 Compare May 15, 2022 14:07
@tk0miya tk0miya merged commit e0835d8 into sphinx-doc:5.0.x May 22, 2022
@tk0miya tk0miya deleted the 9648_autodoc_typehints_description_and_stared_args branch May 22, 2022 04:47
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant