search

JuliaIO / HDF5.jl

Save and load data in the HDF5 file format from Julia
https://juliaio.github.io/HDF5.jl
MIT License
380 stars 138 forks source link

In docs, suggest passing HDF5 module to set_preferences!() instead of UUID #1113

Closed johnomotani closed 10 months ago

johnomotani commented 10 months ago

In the docs, to use custom or system-provided binaries, it is currently suggested to pass the UUID for HDF5.jl to set_preferences!(). It is simpler to load the module with using HDF5, and pass HDF5 directly to set_preferences!(). Is there a reason this is a bad idea?

This PR upates the docs to suggest the method proposed above.

JoshuaLampert commented 10 months ago

After providing a convenience function (#1114) this will even simplify further.

mkitti commented 10 months ago

We should keep the UUID example as a backup.

One frustrating situation that can occur is that the misconfiguration of the libraries might prevent HDF5.jl from loading, making it difficult to pass HDF5 as an argument to remedy the situation.

johnomotani commented 10 months ago

We should keep the UUID example as a backup.

@mkitti sounds good to me - I've put it back.

mkitti commented 10 months ago

LGTM