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

autodoc_unqualified_typehints does not work well with autodoc_typehints="description" #10015

Closed
tk0miya opened this issue Dec 24, 2021 · 0 comments

Comments

@tk0miya
Copy link
Member

tk0miya commented Dec 24, 2021

Describe the bug

autodoc_unqualified_typehints does not work well with autodoc_typehints="description".

How to Reproduce

autodoc_unqualified_typehints = True
autodoc_typehints = "description"

Expected behavior

Typehints in info-field-list are also changed to the short style when autodoc_unqualifed_typehints enabled.

Your project

N/A

Screenshots

No response

OS

Mac

Python version

3.10.1

Sphinx version

HEAD of 4.x

Sphinx extensions

autodoc

Extra tools

No response

Additional context

No response

@tk0miya tk0miya added this to the 4.4.0 milestone Dec 24, 2021
tk0miya added a commit to tk0miya/sphinx that referenced this issue Dec 26, 2021
…not work when autodoc_typehints='description'
tk0miya added a commit that referenced this issue Dec 28, 2021
…pehints_in_description

Fix #10015: autodoc: autodoc_typehints_format='short' does not work when autodoc_typehints='description'
AA-Turner pushed a commit to AA-Turner/sphinx that referenced this issue Dec 29, 2021
…not work when autodoc_typehints='description'
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant