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

Bump griffe from 0.49.0 to 1.0.0 #1069

Merged
merged 1 commit into from
Aug 18, 2024
Merged

Bump griffe from 0.49.0 to 1.0.0 #1069

merged 1 commit into from
Aug 18, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Aug 16, 2024

Bumps griffe from 0.49.0 to 1.0.0.

Release notes

Sourced from griffe's releases.

1.0.0

1.0.0 - 2024-08-15

Compare with 0.49.0

V1! 🚀 🔥 🌈

Breaking changes

Highlights:

  • Extensions inherit from Extension, (VisitorExtension and InspectorExtension are removed)
  • Members are serialized (as_dict/JSON) as a dictionary instead of a list
  • All objects are available in the top-level griffe module, nowhere else

Removed objects:

  • all modules under the griffe package
  • the griffe.DocstringWarningCallable class
  • the griffe.When class
  • the griffe.ExtensionType type
  • the griffe.InspectorExtension class
  • the griffe.VisitorExtension class
  • the griffe.HybridExtension extension
  • the griffe.patch_logger function
  • the griffe.JSONEncoder.docstring_parser attribute
  • the griffe.JSONEncoder.docstring_options attribute
  • the griffe.Extensions.attach_visitor method
  • the griffe.Extensions.attach_inspector method
  • the griffe.Extensions.before_visit method
  • the griffe.Extensions.before_children_visit method
  • the griffe.Extensions.after_children_visit method
  • the griffe.Extensions.after_visit method
  • the griffe.Extensions.before_inspection method
  • the griffe.Extensions.before_children_inspection method
  • the griffe.Extensions.after_children_inspection method
  • the griffe.Extensions.after_inspection method
  • the griffe.GriffeLoader.load_module method
  • the has_special_name and has_private_name properties on objects
  • the is_explicitely_exported and is_implicitely_exported properties on objects
  • the member_is_exported method on objects

Renamed/moved objects:

  • griffe.Function.setter -> griffe.Attribute.setter
  • griffe.Function.deleter -> griffe.Attribute.deleter

Signatures:

... (truncated)

Changelog

Sourced from griffe's changelog.

1.0.0 - 2024-08-15

Compare with 0.49.0

V1! 🚀 🔥 🌈

Breaking changes

Highlights:

  • Extensions inherit from Extension, (VisitorExtension and InspectorExtension are removed)
  • Members are serialized (as_dict/JSON) as a dictionary instead of a list
  • All objects are available in the top-level griffe module, nowhere else

Removed objects:

  • all modules under the griffe package
  • the griffe.DocstringWarningCallable class
  • the griffe.When class
  • the griffe.ExtensionType type
  • the griffe.InspectorExtension class
  • the griffe.VisitorExtension class
  • the griffe.HybridExtension extension
  • the griffe.patch_logger function
  • the griffe.JSONEncoder.docstring_parser attribute
  • the griffe.JSONEncoder.docstring_options attribute
  • the griffe.Extensions.attach_visitor method
  • the griffe.Extensions.attach_inspector method
  • the griffe.Extensions.before_visit method
  • the griffe.Extensions.before_children_visit method
  • the griffe.Extensions.after_children_visit method
  • the griffe.Extensions.after_visit method
  • the griffe.Extensions.before_inspection method
  • the griffe.Extensions.before_children_inspection method
  • the griffe.Extensions.after_children_inspection method
  • the griffe.Extensions.after_inspection method
  • the griffe.GriffeLoader.load_module method
  • the has_special_name and has_private_name properties on objects
  • the is_explicitely_exported and is_implicitely_exported properties on objects
  • the member_is_exported method on objects

Renamed/moved objects:

  • griffe.Function.setter -> griffe.Attribute.setter
  • griffe.Function.deleter -> griffe.Attribute.deleter

Signatures:

  • griffe.docstring_warning(name) parameter was removed

... (truncated)

Commits
  • aad7c86 chore: Prepare release 1.0.0
  • 962d631 docs: Document alternative and downstream projects
  • 16509b8 docs: Document built-in, official and third-party extensions
  • f5d8aa6 docs: Add GitHub workflow example
  • 12567ff docs: Add Markdown anchors to output formats
  • fd72083 refactor: Further code clean up
  • 86d321e refactor: Remove all legacy code for v1
  • 7d9deaf docs: Add projects to insiders list
  • See full diff 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 show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @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)

Bumps [griffe](https://github.com/mkdocstrings/griffe) from 0.49.0 to 1.0.0.
- [Release notes](https://github.com/mkdocstrings/griffe/releases)
- [Changelog](https://github.com/mkdocstrings/griffe/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/griffe@0.49.0...1.0.0)

---
updated-dependencies:
- dependency-name: griffe
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Aug 16, 2024
@sungwy sungwy merged commit 9264c6e into main Aug 18, 2024
7 checks passed
@dependabot dependabot bot deleted the dependabot/pip/griffe-1.0.0 branch August 18, 2024 23:23
sungwy pushed a commit to sungwy/iceberg-python that referenced this pull request Dec 7, 2024
Bumps [griffe](https://github.com/mkdocstrings/griffe) from 0.49.0 to 1.0.0.
- [Release notes](https://github.com/mkdocstrings/griffe/releases)
- [Changelog](https://github.com/mkdocstrings/griffe/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/griffe@0.49.0...1.0.0)

---
updated-dependencies:
- dependency-name: griffe
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
sungwy pushed a commit to sungwy/iceberg-python that referenced this pull request Dec 7, 2024
Bumps [griffe](https://github.com/mkdocstrings/griffe) from 0.49.0 to 1.0.0.
- [Release notes](https://github.com/mkdocstrings/griffe/releases)
- [Changelog](https://github.com/mkdocstrings/griffe/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/griffe@0.49.0...1.0.0)

---
updated-dependencies:
- dependency-name: griffe
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
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 python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant