Improve user api and docs #53
Merged
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
This is groundwork for developing a more flexible API. Instead of always just downloading anything that matches search results and then reading it, users will be able to individually: * Search for data * Download data * Read data
And improve kwarg/variable naming
Also improve the documentation!!
Newer version breaks some things...
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.
Addresses some comments in #50 , improving user API and documentation.
Instead of functions that automatically find, download, and open/transform iceflow-supported data, the updated API centers around the user performing these actions individually. This provides additional control over determining if a download for a search request would be too large.
📚 Documentation preview 📚: https://iceflow--53.org.readthedocs.build/en/53/