Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Where should I document quantization feature? #46

Open
edwardhartnett opened this issue Sep 4, 2021 · 3 comments
Open

Where should I document quantization feature? #46

edwardhartnett opened this issue Sep 4, 2021 · 3 comments

Comments

@edwardhartnett
Copy link

We are adding quantization with the bitgroom filter to the netCDF C/Fortran libraries (see Unidata/netcdf-c#1548)

I have a PR up for the C library (Unidata/netcdf-c#2088) and one for the Fortran library (Unidata/netcdf-fortran#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
Copy link
Collaborator

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
Copy link
Author

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants