Improve error message for undownloadable artifacts #139
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
ph-kev
force-pushed
the
kp/undownloadable-error
branch
from
196569b to
e2cee74
Compare
ph-kev
force-pushed
the
kp/undownloadable-error
branch
from
e2cee74 to
e992b83
Compare
Sbozzolo
reviewed
Dec 11, 2024
src/ClimaArtifacts.jl
Outdated
| )::String | ||
| catch e | ||
| if e isa ErrorException | ||
| msg = "\nThe artifact may also be too large to download. If this is the case, download the artifact directly and indicate where the artifact lives in Overrides.toml (see ClimaArtifacts documentation for how to do this)." |
There was a problem hiding this comment.
Suggested change
| msg = "\nThe artifact may also be too large to download. If this is the case, download the artifact directly and indicate where the artifact lives in Overrides.toml (see ClimaArtifacts documentation for how to do this)." | |
| msg = "\nThe artifact may also be too large to be downloaded automatically. If this is the case, download the artifact directly and indicate where the artifact lives in Overrides.toml (see ClimaArtifacts documentation for how to do this)." |
Sbozzolo
reviewed
Dec 11, 2024
src/ClimaArtifacts.jl
Outdated
| @@ -135,19 +159,15 @@ macro clima_artifact(name, context = nothing) | |||
| $(platform), | |||
| LazyArtifacts, | |||
| )::String | |||
| catch e | |||
| if e isa ErrorException | |||
| msg = "\nThe artifact may also be too large to download. If this is the case, download the artifact directly and indicate where the artifact lives in Overrides.toml (see ClimaArtifacts documentation for how to do this)." | |||
There was a problem hiding this comment.
Suggested change
| msg = "\nThe artifact may also be too large to download. If this is the case, download the artifact directly and indicate where the artifact lives in Overrides.toml (see ClimaArtifacts documentation for how to do this)." | |
| msg = "\nThe artifact may also be too large to be downloaded automatically. If this is the case, download the artifact directly and indicate where the artifact lives in Overrides.toml (see ClimaArtifacts documentation for how to do this)." |
Sbozzolo
approved these changes
Dec 11, 2024
This commit adds a message to the already existing error message that the artifact may be undownloadable and suggests to manually download the artifact and adds the artifact to Overrides.toml if this is the case.
ph-kev
force-pushed
the
kp/undownloadable-error
branch
from
e992b83 to
e4a1189
Compare
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.
closes #106 - This PR adds a message to the already existing error message that the artifact may be undownloadable and suggests to manually download the artifact and adds the artifact to Overrides.toml if this is the case. We do not check if the artifact is undownloadable.
The error message now look like this even if the artifact is downloadable for whatever reason: