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

feat: Add function to find API breaking changes #105

Merged
merged 6 commits into from
Nov 6, 2022

Conversation

pawamoy
Copy link
Member

@pawamoy pawamoy commented Oct 2, 2022

Co-authored-by: Talley Lambert talley.lambert@gmail.com


@tlambert03, following discussion in #75, I've taken your code in griffediff, updated it to my taste (I hope you don't mind 😓) and credited you of course. This PR is still a draft anyway, just experimenting a bit.

What I envision is:

  • utility to yield more than breakages: yield everything that changed or was added/removed (for auto-documentation purposes) and attach these data to objects
  • also attach detected breakages to objects
  • utility to yield forward-compatibility hints: "set these parameters as keyword-only" here and there, etc., and attach these data to objects. These hints could be displayed in docs auto-generated through mkdocstrings when serving only, to inform the developer 🤔
  • of course: add CLI options to show hints and breakages

@tlambert03
Copy link
Contributor

nice! looking good! :)

@pawamoy pawamoy marked this pull request as ready for review November 6, 2022 16:09
@pawamoy pawamoy merged commit 90bded4 into master Nov 6, 2022
@pawamoy pawamoy deleted the detect-breaking-changes branch November 13, 2022 00:02
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.

2 participants