Skip to content

Conversation

@dependabot-preview
Copy link
Contributor

@dependabot-preview dependabot-preview bot commented Apr 15, 2021

Bumps sphinx-autodoc-typehints from 1.11.1 to 1.12.0.

Changelog

Sourced from sphinx-autodoc-typehints's changelog.

1.12.0

  • Dropped Python 3.5 support
  • Added the simplify_optional_unions config option (PR by tillhainbach)
  • Fixed indentation of multiline strings (PR by Yuxin Wu)

1.11.1

  • Changed formatting of None to point to the Python stdlib docs (PR by Dominic Davis-Foster)
  • Updated special dataclass handling (PR by Lihu Ben-Ezri-Ravin)

1.11.0

  • Dropped support for Sphinx < 3.0
  • Added support for alternative parameter names (arg, argument, parameter)
  • Fixed import path for Signature (PR by Matthew Treinish)
  • Fixed TypeError when formatting a parametrized typing.IO annotation
  • Fixed data class displaying a return type in its __init__() method

1.10.3

  • Fixed TypeError (or wrong rendered class name) when an annotation is a generic class that has a name property

1.10.2

  • Fixed inner classes missing their parent class name(s) when rendered

1.10.1

  • Fixed KeyError when encountering mocked annotations (autodoc_mock_imports)

1.10.0

  • Rewrote the annotation formatting logic (fixes Python 3.5.2 compatibility regressions and an AttributeError regression introduced in v1.9.0)
  • Fixed decorator classes not being processed as classes

1.9.0

  • Added support for typing_extensions
  • Added the typehints_document_rtype option (PR by Simon-Martin Schröder)
  • Fixed metaclasses as annotations causing TypeError
  • Fixed rendering of typing.Literal
  • Fixed OSError when generating docs for SQLAlchemy mapped classes
  • Fixed unparametrized generic classes being rendered with their type parameters (e.g. Dict[~KT, ~VT])

1.8.0

  • Fixed regression which caused TypeError or OSError when trying to set annotations due to PR #87
  • Fixed unintentional mangling of annotation type names
  • Added proper :py:data targets for NoReturn, ClassVar and Tuple

... (truncated)

Commits
  • 1b85ff5 Added the release version
  • 3e2df90 Updated the changelog
  • 49face6 Fixed indentation of multiline strings (#166)
  • c95c959 Removed debugging code
  • 147368a Added (and fixed) Python 3.10 support
  • fe49c40 Removed Python 3.5 special cases
  • 6933aa5 Removed conditional import for typing.IO
  • e8cbd68 Added missing extra to "pip install"
  • 63b415f Moved pytest settings to pyproject.toml
  • fcead9a Enforce sorting of imports
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
  • @dependabot use these labels will set the current labels as the default for future PRs for this repo and language
  • @dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
  • @dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
  • @dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language
  • @dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

  • Update frequency (including time of day and day of week)
  • Pull request limits (per update run and/or open at any time)
  • Automerge options (never/patch/minor, and dev/runtime dependencies)
  • Out-of-range updates (receive only lockfile updates, if desired)
  • Security updates (receive only security updates, if desired)

@dependabot-preview dependabot-preview bot added the dependencies Pull requests that update a dependency file label Apr 15, 2021
@dependabot-preview dependabot-preview bot force-pushed the dependabot/pip/sphinx-autodoc-typehints-1.12.0 branch from 008f2dc to 32f0ba8 Compare April 16, 2021 20:01
@codecov-commenter
Copy link

codecov-commenter commented Apr 16, 2021

Codecov Report

Merging #77 (8f52f2a) into master (72a771d) will not change coverage.
The diff coverage is n/a.

❗ Current head 8f52f2a differs from pull request most recent head 32f0ba8. Consider uploading reports for the commit 32f0ba8 to get more accurate results
Impacted file tree graph

@@            Coverage Diff            @@
##            master       #77   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines          107       107           
  Branches         2         2           
=========================================
  Hits           107       107           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 72a771d...32f0ba8. Read the comment docs.

@thepabloaguilar thepabloaguilar merged commit e99ed16 into master Apr 20, 2021
@dependabot-preview dependabot-preview bot deleted the dependabot/pip/sphinx-autodoc-typehints-1.12.0 branch April 20, 2021 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file

Development

Successfully merging this pull request may close these issues.

3 participants