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.16.0 to <1.19.0 #224

Open
wants to merge 2 commits into
base: devel
Choose a base branch
from

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Apr 13, 2022

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

Changelog

Sourced from sphinx-autodoc-typehints's changelog.

1.18.0

  • Support and require nptyping>=2
  • Handle UnionType

1.17.1

  • Mark it as requiring nptyping<2

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

... (truncated)

Commits

You can trigger a rebase of this PR 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)
> **Note** > Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

@jvesely
Copy link
Owner

jvesely commented Apr 19, 2022

@dependabot rebase

1 similar comment
@jvesely
Copy link
Owner

jvesely commented Apr 19, 2022

@dependabot rebase

@jvesely
Copy link
Owner

jvesely commented Apr 20, 2022

@dependabot recreate

1 similar comment
@jvesely
Copy link
Owner

jvesely commented Apr 20, 2022

@dependabot recreate

@jvesely jvesely force-pushed the dependabot/pip/devel/sphinx-autodoc-typehints-lt-1.19.0 branch from 1766361 to d580cd3 Compare April 20, 2022 00:29
@jvesely
Copy link
Owner

jvesely commented Apr 20, 2022

@dependabot recreate

@jvesely jvesely force-pushed the dependabot/pip/devel/sphinx-autodoc-typehints-lt-1.19.0 branch from d580cd3 to 4f1873a Compare April 20, 2022 00:46
@jvesely jvesely force-pushed the dependabot/pip/devel/sphinx-autodoc-typehints-lt-1.19.0 branch from 4f1873a to 44e8e57 Compare April 20, 2022 00:52
Check all requirements files.
Account for -/_ ambiguity in package names.
Skip the check when building the "base" documentation variant.

Fixes: 0aa4359
("github-actions/pnl-install: Check if a newly bumped dependency is
rolled back during installation (PrincetonUniversity#2390)")

Signed-off-by: Jan Vesely <[email protected]>
@jvesely
Copy link
Owner

jvesely commented Apr 20, 2022

@dependabot rebase

@dependabot @github
Copy link
Author

dependabot bot commented on behalf of github Apr 20, 2022

Looks like this PR has been edited by someone other than Dependabot. That means Dependabot can't rebase it - sorry!

If you're happy for Dependabot to recreate it from scratch, overwriting any edits, you can request @dependabot recreate.

@dependabot @github
Copy link
Author

dependabot bot commented on behalf of github Apr 20, 2022

A newer version of sphinx-autodoc-typehints exists, but since this PR has been edited by someone other than Dependabot I haven't updated it. You'll get a PR for the updated version as normal once this PR is merged.

@jvesely
Copy link
Owner

jvesely commented Apr 20, 2022

@dependabot recreate

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.18.0)

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

Signed-off-by: dependabot[bot] <[email protected]>
@jvesely jvesely force-pushed the dependabot/pip/devel/sphinx-autodoc-typehints-lt-1.19.0 branch from 44e8e57 to db59c7f Compare April 20, 2022 02:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deps Dependencies version bump
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant