refactor(docs): update installation instructions for GOES-DL package #7
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
Reviewer's Guide by SourceryThis PR updates the installation and usage documentation in the README.md file. The changes clarify the installation process and provide more detailed examples for downloading data from different GOES satellite sources, including specific information about data repositories and caching configurations. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Here's the code health analysis summary for commits Analysis Summary
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @wvenialbo - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 2 issues found
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| datasource = DatasourceAWS(locator) | ||
| # GOES-16 data is updated every 10 minutes. If you are downloading | ||
| # old data, you may leave the cache refresh rate as default (+inf). | ||
| datasource = DatasourceAWS(locator, repository="./my_data/goes-r", cache=600) |
There was a problem hiding this comment.
suggestion (documentation): Consider explaining the cache parameter's default value
The comment mentions '+inf' as the default value, but this might not be clear to all users. Consider adding a note about what this means in practice.
# GOES-16 data is updated every 10 minutes. If you are downloading
# old data, the default cache value (infinity) means files will never expire.
# Set cache=600 to refresh data every 10 minutes.
datasource = DatasourceAWS(locator, repository="./my_data/goes-r", cache=600)
| end="1984-08-24T00:00-0004", | ||
| ) | ||
|
|
||
| # `files1` and files2` are lists of tuple[str, bytes] with file path and |
There was a problem hiding this comment.
issue (documentation): Fix missing backtick in files2 variable name
wvenialbo
added a commit
that referenced
this pull request
Oct 29, 2024
Merge pull request #7 from wvenialbo/fix-readme-v0.1-rc2
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.
Summary by Sourcery
Revise the documentation to update the installation instructions for the GOES-DL package, clarify data source archives, and introduce additional configuration options for data downloading.
Documentation: