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: The default of autodoc_typehints_format becomes to 'smart' #10037

Merged

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Jan 1, 2022

Feature or Bugfix

  • Feature

Purpose

@tk0miya tk0miya added type:enhancement enhance or introduce a new feature extensions:autodoc labels Jan 1, 2022
@tk0miya tk0miya added this to the 5.0.0 milestone Jan 1, 2022
@tk0miya tk0miya force-pushed the 9075_default_autodoc_typehints_format branch from b455edd to 01e6436 Compare January 1, 2022 10:40
The default value of autodoc_typehints_format configuration is changed
to `'smart'`.  It will suppress the leading module names of typehints
(ex. `io.StringIO` -> `StringIO`).

refs: sphinx-doc#9075
@tk0miya tk0miya force-pushed the 9075_default_autodoc_typehints_format branch from 01e6436 to 616f112 Compare January 2, 2022 08:35
@tk0miya tk0miya closed this Jan 2, 2022
@tk0miya tk0miya reopened this Jan 2, 2022
@tk0miya tk0miya changed the base branch from master to 4.x January 2, 2022 09:05
@tk0miya tk0miya changed the base branch from 4.x to master January 2, 2022 09:05
@tk0miya tk0miya merged commit d417b0a into sphinx-doc:master Jan 2, 2022
@tk0miya tk0miya deleted the 9075_default_autodoc_typehints_format branch January 2, 2022 09:17
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
extensions:autodoc type:enhancement enhance or introduce a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant