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

requirements: update sphinx-autodoc-typehints requirement from <1.17.0 to <1.18.0 #2319

Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Feb 11, 2022

Updates the requirements on sphinx-autodoc-typehints to permit the latest version.

Changelog

Sourced from sphinx-autodoc-typehints's changelog.

1.17.0

  • Add typehints_use_rtype option
  • Handles TypeError when getting source code via inspect

1.16.0

  • Add support for type subscriptions with multiple elements, where one or more elements are tuples; e.g., nptyping.NDArray[(Any, ...), nptyping.Float]
  • Fix bug for arbitrary types accepting singleton subscriptions; e.g., nptyping.Float[64]
  • Resolve forward references
  • Expand and better handle TypeVar
  • Add intershpinx reference link for ... to Ellipsis (as is just an alias)

1.15.3

  • Prevents reaching inner blocks that contains if TYPE_CHECKING

1.15.2

  • Log a warning instead of crashing when a type guard import fails to resolve
  • When resolving type guard imports if the target module does not have source code (such is the case for C-extension modules) do nothing instead of crashing

1.15.1

  • Fix fully_qualified should be typehints_fully_qualified

1.15.0

  • Resolve type guard imports before evaluating annotations for objects
  • Remove set_type_checking_flag flag as this is now done by default
  • Fix crash when the inspect module returns an invalid python syntax source
  • Made formatting function configurable using the option typehints_formatter

1.14.1

  • Fixed normalize_source_lines() messing with the indentation of methods with decorators that have parameters starting with def.
  • Handle ValueError or TypeError being raised when signature of an object cannot be determined
  • Fix KeyError being thrown when argument is not documented (e.g. cls argument for class methods, and self for methods)

1.14.0

  • Added typehints_defaults config option allowing to automatically annotate parameter defaults.

1.13.1

  • Fixed NewType inserts a reference as first argument instead of a string

... (truncated)

Commits
  • 1ef8488 Release 1.17.0
  • aa345ca Add typehints_use_rtype option (#218)
  • a022d1a inspect.getsource can raise TypeError (#210)
  • 0807d00 [pre-commit.ci] pre-commit autoupdate (#215)
  • 8b0599d Handle ForwardRef, expand TypeVar and link Ellipsis (#214)
  • f75d19b Add handling of tuples in type subscriptions (#212)
  • 7b8c357 ADMIN: Update pepy.tech link in badge (#213)
  • 3492d49 Prevents reaching inner blocks that contains if TYPE_CHECKING (#211)
  • 01b3a1a More robust handling of type guard imports (#208)
  • d770c69 Fix fully_qualified should be typehints_fully_qualified (#204)
  • Additional commits viewable in compare view

You can trigger a rebase of this PR by commenting @dependabot rebase.

Dependabot will merge this PR once CI passes on it, as requested by @jvesely.


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 dependabot bot added the deps Dependency update label Feb 11, 2022
@github-actions
Copy link

This PR causes the following changes to the html docs (ubuntu-latest-3.7-x64):

No differences!

...

See CI logs for the full diff.

@jvesely
Copy link
Collaborator

jvesely commented Feb 13, 2022

@dependabot rebase

1 similar comment
@jvesely
Copy link
Collaborator

jvesely commented Feb 13, 2022

@dependabot rebase

Updates the requirements on [sphinx-autodoc-typehints](https://github.com/tox-dev/sphinx-autodoc-typehints) to permit the latest version.
- [Release notes](https://github.com/tox-dev/sphinx-autodoc-typehints/releases)
- [Changelog](https://github.com/tox-dev/sphinx-autodoc-typehints/blob/main/CHANGELOG.md)
- [Commits](tox-dev/sphinx-autodoc-typehints@1.0.0...1.17.0)

---
updated-dependencies:
- dependency-name: sphinx-autodoc-typehints
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/pip/devel/sphinx-autodoc-typehints-lt-1.18.0 branch from 902f3f4 to f73203f Compare February 13, 2022 03:12
@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Feb 13, 2022

Looks like this PR is already up-to-date with devel! If you'd still like to recreate it from scratch, overwriting any edits, you can request @dependabot recreate.

@github-actions
Copy link

This PR causes the following changes to the html docs (ubuntu-latest-3.7-x64):

No differences!

...

See CI logs for the full diff.

@jvesely
Copy link
Collaborator

jvesely commented Feb 13, 2022

@dependabot squash and merge

@dependabot dependabot bot merged commit 801f40c into devel Feb 13, 2022
@dependabot dependabot bot deleted the dependabot/pip/devel/sphinx-autodoc-typehints-lt-1.18.0 branch February 13, 2022 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deps Dependency update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant