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

refactor: Rewrite diff logic to actually return differences, not just breaking changes #278

Open
pawamoy opened this issue May 25, 2024 · 0 comments
Assignees
Labels
feature New feature or request fund Issue priority can be boosted

Comments

@pawamoy
Copy link
Member

pawamoy commented May 25, 2024

Is your feature request related to a problem? Please describe.

I have plans for Griffe 😤 I want not only to detect breaking changes, but all kinds of things: places where the API can be improved, places where the API is not super forward-compatible, things that became deprecated, etc.. I want to support adding these "Changed in", "Removed in", "Added in" admonitions in docs automatically.

Currently the diff module only yields breaking changes. Adding other utils to yield plain changes would duplicate the code and make things inefficient.

Describe the solution you'd like

Rewrite utils to yield plain changes. Each change could then have flags? Like a "hint", "warning", "deprecation", "breakage" flag or flags. The find_breaking_changes function would simply filter the detected changes.

Describe alternatives you've considered

/

Additional context

/

Boost priority

  • Boost priority in our backlog through Polar.sh. Higher pledge, higher priority.
  • Minimum pledge by user/organization is $5, minimum amount for boost is $30.
  • View all issues with pledges.
  • We receive the funds once the issue is completed and confirmed by you.
  • Features with the insiders label are released to sponsors first, and tied to a funding goal.
Fund with Polar
@pawamoy pawamoy added the feature New feature or request label May 25, 2024
@pawamoy pawamoy self-assigned this May 25, 2024
@pawamoy pawamoy added this to the 1.0.0 milestone Jun 8, 2024
@pawamoy pawamoy removed this from the 1.0.0 milestone Aug 14, 2024
@pawamoy pawamoy added the fund Issue priority can be boosted label Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request fund Issue priority can be boosted
Projects
None yet
Development

No branches or pull requests

1 participant