search

JuliaIO / HDF5.jl

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

Copy a group of data from a file to another #1070

Closed linwaytin closed 1 year ago

linwaytin commented 1 year ago

I have a file old.h5 with data group like data/foo1, data/foo2, and so on. I want to copy this group to another file new.h5. The following seems to work.

copy_object(fid_old["data"], fid_new, "data")

where fid_old and fid_new are the corresponding file handles.

My question is that this function copy_object is not documented. I found it in the source code. Is this function not stable enough, or it just hasn't been put in the document?

By the way, I want to thank the developers of this package. It is easy to use. Especially the Dictionary syntax is super convenient!

mkitti commented 1 year ago

Could you submit a pull request with a docstring for it?

You could also look at the Documenter.jl docs and include the docstring somewhere.

Also double check that we test this function.

Let me know if you need help.

linwaytin commented 1 year ago

Yes, I can do that. So the function is considered to be stable, just not documented yet? I'm gonna use it so I would like to know what the status is. Thank you.

mkitti commented 1 year ago

So the function is considered to be stable, just not documented yet?

It will be once it's added to the documentation. That's why I'm encouraging you to send the pull request. Otherwise, I'll add it to my long queue of things to do.

linwaytin commented 1 year ago

Ok I will try to work on that. I would also like to add documentation to delete_object, which is another very useful function.

mkitti commented 1 year ago

Closed by #1071