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

Update griffe requirement from <0.22.0,>=0.20.0 to >=0.20.0,<0.25.0 #41

Closed

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Nov 14, 2022

Updates the requirements on griffe to permit the latest version.

Changelog

Sourced from griffe's changelog.

0.24.0 - 2022-11-13

Compare with 0.23.0

The "Breaking Changes" and "Deprecations" sections are proudly written with the help of our new API breakage detection feature 😄! Many thanks to Talley Lambert (@​tlambert03) for the initial code allowing to compare two Griffe trees.

Breaking changes

  • All parameters of the [load_git][griffe.git.load_git] function, except module, are now keyword-only.
  • Parameter try_relative_path of the [load_git][griffe.git.load_git] function was removed.
  • Parameter commit was renamed ref in the [load_git][griffe.git.load_git] function.
  • Parameter commit was renamed ref in the [tmp_worktree][griffe.git.tmp_worktree] helper, which will probably become private later.
  • Parameters ref and repo switched positions in the [tmp_worktree][griffe.git.tmp_worktree] helper.
  • All parameters of the [resolve_aliases][griffe.loader.GriffeLoader.resolve_aliases] method are now keyword-only.
  • Parameters only_exported and only_known_modules of the [resolve_module_aliases][griffe.loader.GriffeLoader.resolve_module_aliases] method were removed. This method is most probably not used by anyone, and will probably be made private in the future.

Deprecations

  • Parameters only_exported and only_known_modules of the [resolve_aliases][griffe.loader.GriffeLoader.resolve_aliases] method are deprecated in favor of their inverted counter-part implicit and external parameters.

    • Example before: loader.resolve_aliases(only_exported=True, only_known_modules=True)
    • Example after: loader.resolve_aliases(implicit=False, external=False)

Features

Bug Fixes

Code Refactoring

  • Rename some parameters in Git module (9ad7a2c by Timothée Mazzucotelli).
  • Set parameters as keyword-only (44c01be by Timothée Mazzucotelli).
  • Remove stars from parameters names (91dce14 by Timothée Mazzucotelli).
  • Refactor CLI to use subcommands (760b091 by Timothée Mazzucotelli). [PR #110](mkdocstrings/griffe#110)
  • Rename parameters used when resolving aliases (3d3a4eb by Timothée Mazzucotelli).

0.23.0 - 2022-10-26

Compare with 0.22.2

Features

... (truncated)

Commits
  • de97eb1 chore: Prepare release 0.24.0
  • 610e89f docs: Rework documentation
  • 25060f6 fix: Fix labels mismatch staticmethod-classmethod in inspector
  • f297f1a fix: Prevent infinite loop while looking for package's parent folder
  • 267bede refactor: Improve display of moved parameter breakage
  • 9ad7a2c refactor: Rename some parameters in Git module
  • 90bded4 feat: Add CLI command to check for API breakages
  • 07bffff fix: Fix comparing names and expressions
  • 44c01be refactor: Set parameters as keyword-only
  • 91dce14 refactor: Remove stars from parameters names
  • Additional commits viewable in compare view

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)

Updates the requirements on [griffe](https://github.com/mkdocstrings/griffe) to permit the latest version.
- [Release notes](https://github.com/mkdocstrings/griffe/releases)
- [Changelog](https://github.com/mkdocstrings/griffe/blob/master/CHANGELOG.md)
- [Commits](mkdocstrings/griffe@0.20.0...0.24.0)

---
updated-dependencies:
- dependency-name: griffe
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @github
Copy link
Author

dependabot bot commented on behalf of github Nov 14, 2022

The following labels could not be found: maintenance.

@dependabot @github
Copy link
Author

dependabot bot commented on behalf of github Dec 12, 2022

Superseded by #46.

@dependabot dependabot bot closed this Dec 12, 2022
@dependabot dependabot bot deleted the dependabot/pip/griffe-gte-0.20.0-and-lt-0.25.0 branch December 12, 2022 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants