New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add instructions for adding a file to the cache #938
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like good instructions to have.
CONTRIBUTING.md
Outdated
|
||
## Cached Data Files | ||
MetPy keeps some test data, as well as things like shape files for US counties in a data cahce | ||
supported by the pooch library. To add files to this, please ensure they are the minimum size. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"they are the minimum size" -> "they are as small as possible"?
CONTRIBUTING.md
Outdated
|
||
## Cached Data Files | ||
MetPy keeps some test data, as well as things like shape files for US counties in a data cahce | ||
supported by the pooch library. To add files to this, please ensure they are the minimum size. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add that this command should be run in the same directory that contains the staticdata directory - just to make it clear.
CONTRIBUTING.md
Outdated
@@ -200,6 +200,18 @@ to run only the test you just created for this step. | |||
|
|||
For more information, see the `docs for mpl-test <https://github.com/astrofrog/pytest-mpl>`_. | |||
|
|||
|
|||
## Cached Data Files | |||
MetPy keeps some test data, as well as things like shape files for US counties in a data cahce |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"cahce" = "cache"
ffe5aa6
to
1e3b13e
Compare
Ok - should be good to go unless anyone sees anything else! |
Is there anything else that you would have found useful here @kgoebber? Adding instructions for putting files in the cache.