Update CUBED_CONFIG path in example README.md #530
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
While testing cubed, I was experiencing a lot of new-user environment issues. One issue was that I'd setup `CUBED_CONFIG` to point to a directory rather than a file path, as is shown in this example. However, I was hacking on a problem and had several `yaml` files that I was testing on. Depending on my naming convention, different files might get picked up as my `CUBED_CONFIG`. A better practice is to explicitly name the file in the README example.
thodson-usgs
added a commit
to thodson-usgs/cubed
that referenced
this pull request
Oct 24, 2024
While testing cubed, I was experiencing a lot of new-user environment issues. One issue was that I'd setup `CUBED_CONFIG` to point to a directory rather than a file path, as is shown in this example. However, I was hacking on a problem and had several `yaml` files that I was testing on. Depending on my naming convention, different files might get picked up as my `CUBED_CONFIG`. A better practice is to explicitly name the file in the README example.
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.
While testing cubed, I was experiencing a lot of new-user environment issues. One issue was that I'd setup
CUBED_CONFIGto point to a directory rather than ayamlfile, as is shown in README example. However, I was hacking on a problem and had severalyamlfiles that I was testing. Depending on my naming convention, different files might get picked up as myCUBED_CONFIG. A better practice is to explicitly name the file in the README example.Specifically, like