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

feature: API checks: diff each sequence/mapping value instead of the whole #245

Open
pawamoy opened this issue Mar 2, 2024 · 0 comments
Assignees
Labels
feature New feature or request

Comments

@pawamoy
Copy link
Member

pawamoy commented Mar 2, 2024

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

Griffe warns about changed values for attributes, but these are often false positives.

Describe the solution you'd like

Instead of diff a whole dictionary, we should check each one of its key/value pairs. Key removed? Breaking change. Value changed? Breaking change. Added key? Not a breaking change.

Same for lists/tuples, but check ordering too. For sets, only check that nothing was removed.

Describe alternatives you've considered

/

Additional context

/

@pawamoy pawamoy added the feature New feature or request label Mar 2, 2024
@pawamoy pawamoy self-assigned this Mar 2, 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
Projects
None yet
Development

No branches or pull requests

1 participant