[WIP] Clarify the Use of Public API Methods #212
Draft
Conversation
This file contains 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
added 7 commits
June 5, 2021 13:19
Since Genius inherits and then initiates its parent objects, we need to add the **kwargs parameter to the init of other objects so that they ignore the allow_public_api parameter.
Made clear in Genius methods docstrings that they use PublicAPI methods. The same needs to be added to the docstrings of the PublicAPI methods.
|
Also, all Public API references (in code as well as docs) should be renamed to Web API. Genius considers its official API to be the Public API and refers to the unofficial API as Web API. Renaming these will create reduce confusion. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR makes the use of Public API methods clear to the user and also makes sure the user accepts the risks of the Public API before using its methods.
This PR introduces breaking changes and mustn't be merged until 4.0.0