search

geospace-code / h5fortran

Lightweight HDF5 polymorphic Fortran: h5write() h5read()
https://geospace-code.github.io/h5fortran
BSD 3-Clause "New" or "Revised" License
99 stars 23 forks source link

Documentation: statement of need and target audience #17

Closed bast closed 3 years ago

bast commented 3 years ago

This concerns JOSS review checklist "Do the authors clearly state what problems the software is designed to solve and who the target audience is?".

I like how the README.md starts with a usage example and a one sentence summary. But I think the documentation could have 2 sentences more there clarifying what this library solves. I think this is nicely done in the paper draft "... that abstracts away most details of a frequently-used subset of HDF5 operations".

I think 2 sentences more on when to use it and what functions are available and how this is now simpler would be helpful. Thank you!

(working on https://github.com/openjournals/joss-reviews/issues/2842)

scivision commented 3 years ago

thanks this is done in https://github.com/geospace-code/h5fortran/commit/593f63693a30b90cb0d681f074a9b2cc1eb80742

bast commented 3 years ago

Thank you!