In docs, suggest passing HDF5 module to set_preferences!() instead of UUID #1113
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
It is possible to pass a module to `set_preferences!()`, as an alternative to identifying the module by its UUID. This is easier to read or type, so better to suggest this method in the docs.
|
After providing a convenience function (#1114) this will even simplify further. |
|
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. |
@mkitti sounds good to me - I've put it back. |
|
LGTM |
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.
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 withusing HDF5, and passHDF5directly toset_preferences!(). Is there a reason this is a bad idea?This PR upates the docs to suggest the method proposed above.