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

chore(v3)!: remove unnecessary underscores #885

Merged
merged 1 commit into from
Nov 28, 2024

Conversation

JP-Ellis
Copy link
Contributor

📝 Summary

The arguments to __exit__ are not used. When first implemented, this used the leading underscores to make that explicit; however, this is incompatible with the expected type signature of the function.

🚨 Breaking Changes

The PactServer __exit__ arguments no longer have leading underscores. This is typically handled by Python itself and therefore is unlikely to be a change for any user, unless the end user was calling the __exit__ method explicitly and using keyword arguments.

🔥 Motivation

Better compatibility with the expected behaviour of __exit__

🔨 Test Plan

CI

🔗 Related issues/PRs

None

The arguments to `__exit__` are not used. When first implemented, this
used the leading underscores to make that explicit; however, this is
incompatible with the expected type signature of the function.

BREAKING CHANGE: The PactServer `__exit__` arguments no longer have
    leading underscores. This is typically handled by Python itself and
    therefore is unlikely to be a change for any user, unless the end
    user was calling the `__exit__` method explicitly _and_ using
    keyword arguments.

Signed-off-by: JP-Ellis <josh@jpellis.me>
@JP-Ellis JP-Ellis self-assigned this Nov 27, 2024
Copy link

codecov bot commented Nov 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78%. Comparing base (0fa56c9) to head (632e67c).
Report is 2 commits behind head on main.

Additional details and impacted files
@@         Coverage Diff         @@
##           main   #885   +/-   ##
===================================
  Coverage    78%    78%           
===================================
  Files        30     30           
  Lines      3365   3365           
===================================
  Hits       2634   2634           
  Misses      731    731           
Flag Coverage Δ
examples 59% <ø> (ø)
tests 75% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JP-Ellis JP-Ellis merged commit 1db2de1 into main Nov 28, 2024
36 of 37 checks passed
@JP-Ellis JP-Ellis deleted the chore/remove-unnecessary-underscores branch November 28, 2024 00:49
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.

1 participant