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

Fix `h5readattr` docstring #1119

Closed Sbozzolo closed 10 months ago

Sbozzolo commented 10 months ago

The function does not take a third argument.

mkitti commented 10 months ago

You are correct. I think this was just a typo introduced in
8338e09f05d1e05c83b9e7bf64fb26797191b563 by @simonbyrne .

We could show a type assertion for the return type, but I'm not sure if that is currently the norm.

mkitti commented 10 months ago

Test failure is due to h5a_iterate failing to throw on Ubuntu.

mkitti commented 10 months ago

Fix is valid and only affects documentation. Merging.