search

Unidata / netcdf

NetCDF Users Group (NUG)
MIT License
6 stars 10 forks source link

Where should I document quantization feature? #46

Open edwardhartnett opened 3 years ago

edwardhartnett commented 3 years ago

We are adding quantization with the bitgroom filter to the netCDF C/Fortran libraries (see https://github.com/Unidata/netcdf-c/issues/1548)

I have a PR up for the C library (https://github.com/Unidata/netcdf-c/pull/2088) and one for the Fortran library (https://github.com/Unidata/netcdf-fortran/pull/304) and each of those have documentation changes supporting the new quantize functions.

I would also like to add a section to the language neutral docs, but I'm not sure where in this repo I should do that. It should be near wherever compression is explained.

DennisHeimbigner commented 3 years ago

Since the creation of a separate NUG repository, documentation is split. The NUG needs hold only non-independent descriptions of quantize. The netcdf-c/docs directory needs to hold language specific documentation.

edwardhartnett commented 3 years ago

Sure, I get that. And I have added docs in the netcdf-c and netcdf-fortran repos. But I would also like to add a section on quantize to the language neutral docs. It's an important feature, that even users of other languages (like netcdf-java) need to be aware of.

edwardhartnett commented 2 years ago

I have added this documentation to the netcdf-c documentation.