Skip to content

Misleading documentation note for NC_FORMATX_NCZARR #3007

@sval-dev

Description

@sval-dev
  • 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions