MNT Swap the names of _get_state <=> get_state & _get_instance <=> get_instance #161
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
The functions that should be actually used everywhere are _get_state and _get_instance, not get_state and get_instance. This is inconvenient and confusing. Therefore, swap out the names so that the functions being used everywhere now have the "public" name and the other ones the "private" name. This was discussed here: skops-dev#143 (comment)
|
Ready for review @skops-dev/maintainers |
adrinjalali
reviewed
Sep 30, 2022
skops/io/_persist.py
Outdated
| @@ -54,7 +54,7 @@ def save(obj, file): | |||
| """ | |||
| with tempfile.TemporaryDirectory() as dst: | |||
| with open(Path(dst) / "schema.json", "w") as f: | |||
| state = get_state(obj, dst) | |||
| state = _get_state(obj, dst) | |||
There was a problem hiding this comment.
why aren't we using get_state (with the new def) here?
There was a problem hiding this comment.
Yes, that should work, I did a simple search/replace here, I made the change now.
adrinjalali
approved these changes
Sep 30, 2022
adrinjalali
changed the title
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.
The functions that should be actually used everywhere are
_get_stateand_get_instance, notget_stateandget_instance. This is inconvenient and confusing. Therefore, swap out the names so that the functions being used everywhere now have the "public" name and the other ones the "private" name.This was discussed here.