You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you want the readers to use our artifact, you indeed need to tell them to copy this file into their project dir and to include the command that ensures that the artifact gets downloaded (Pkg.ensure_artifact_installed("uai2014", "Artifacts.toml")).
Instead of Pkg.ensure_artifact_installed("uai2014", "Artifacts.toml"), can we build the function into our package so that in the documentation we can write:
We still have Artifacts as a dependency, but will not download data automaticall for users.
Because it is very anoying when a user was told to find a specific file in his filesystem to follow a documentation. Especially for windows users.
Since we already have read_instance, read_instance_from_string, we could name this new function read_instance_from_artifact to keep the naming consistent. I was also thinking that perhaps we could always do the check (Pkg.ensure_artifact_installed(artifact_name, artifact_toml)) inside this function so that it becomes transparent to the user.
Instead of
Pkg.ensure_artifact_installed("uai2014", "Artifacts.toml")
, can we build the function into our package so that in the documentation we can write:We still have
Artifacts
as a dependency, but will not download data automaticall for users.Because it is very anoying when a user was told to find a specific file in his filesystem to follow a documentation. Especially for windows users.
Originally posted by @GiggleLiu in #41 (comment)
The text was updated successfully, but these errors were encountered: