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

Misleading documentation note for NC_FORMATX_NCZARR #3007

Closed
sval-dev opened this issue Aug 30, 2024 · 1 comment · Fixed by #3035
Closed

Misleading documentation note for NC_FORMATX_NCZARR #3007

sval-dev opened this issue Aug 30, 2024 · 1 comment · Fixed by #3035

Comments

@sval-dev
Copy link

sval-dev commented Aug 30, 2024

  • the version of the software with which you are encountering an issue
    Current main

  • a description of the issue with the steps needed to reproduce it

The documentation for the NC_FORMATX_NCZARR states that it was "Added in version 4.3.1", however that is not accurate.
Instead, NC_FORMATX_ZARR was added in 4.3.1, and then the NC_FORMATX_ZARR symbol was renamed to NC_FORMAT_NCZARR released as part of 4.8.0 (renamed in 59e04a).

This issue surfaced since version 1.7.1post2 of the python module uses this symbol, and version 4.7.0 of the C library was on the system, but we got:
external/nc_complex/src/nc_complex.c:637:21: error: ‘NC_FORMATX_NCZARR’ undeclared (first use in this function)

Looking up the symbol suggested it was introduced in 4.3.1, and given that 4.7.0 was on the system led to some confusion.

@WardF
Copy link
Member

WardF commented Sep 3, 2024

Thanks! I will update the documentation to reflect this!

WardF added a commit to WardF/netcdf-c that referenced this issue Sep 30, 2024
WardF added a commit that referenced this issue Sep 30, 2024
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

Successfully merging a pull request may close this issue.

2 participants