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

Update documentation about using files in memory #1118

Closed denglerchr closed 9 months ago

denglerchr commented 10 months ago

An entry in the doc and a small correction of the Drivers.Core doc-string. For recently added functionality in https://github.com/JuliaIO/HDF5.jl/issues/552

mkitti commented 10 months ago

Thanks. I will look this over this weekend.

mkitti commented 10 months ago

This is mergeable.

I would like to investigate how the default was documented wrong.

Also, I would prefer the do syntax with h5open as well as using jldoctest.

Let me know if you are interested in iterating or not.

denglerchr commented 10 months ago

Seems like the default for the Core driver has been documented like this from its creation https://github.com/JuliaIO/HDF5.jl/commit/0eaec093399de9e7fb96ee3cd7b190a71871aed2#diff-eaf75d58da3a8bb4a3287bf539f3167efd5c7e8dc58c23289560013c98ac7b16 Ill changed to the do syntax for the examples

mkitti commented 10 months ago

Right, but how did that happen. Is there a mismatch between upstream and this package?