Enhancing user-facing API#21
Open
AHReccese wants to merge 12 commits into
Open
Conversation
AHReccese
added
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #21 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 4 +2
Lines 47 80 +33
Branches 0 1 +1
=========================================
+ Hits 47 80 +33 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 17 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
In this PR, I've tried to enhance user-facing API, also keeping backward compatibility for direct use of global adapter (which we previously released) but with deprecation flag. We don't expose internal concrete adapters to user, only coarse-grained factory function & classes plus their required enums to config properly.
one note (I thought you might ask):
IPForceAdapteris a function (def IPForceAdapter(...)) but uses class-style PascalCase naming. There is a recognized Python idiom where factory functions that act as constructors use PascalCase to signal "this returns an instance, treat it like a class call", for exampletyping.NamedTuplefrom the standard library.What does this implement/fix? Explain your changes.
Any other comments?