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

Missing Error Codes in Documentation #3072

Closed
mathomp4 opened this issue Jan 9, 2025 · 1 comment · Fixed by #3073
Closed

Missing Error Codes in Documentation #3072

mathomp4 opened this issue Jan 9, 2025 · 1 comment · Fixed by #3073
Assignees
Milestone

Comments

@mathomp4
Copy link

mathomp4 commented Jan 9, 2025

I noticed recently that the current error codes doc page:

https://docs.unidata.ucar.edu/netcdf-c/current/nc-error-codes.html

seems to be missing some newer error codes:

netcdf-c/include/netcdf.h

Lines 527 to 533 in 72ea68f

#define NC_ENOFILTER (-136) /**< Filter not defined on variable. */
#define NC_ENCZARR (-137) /**< Error at NCZarr layer. */
#define NC_ES3 (-138) /**< Generic S3 error */
#define NC_EEMPTY (-139) /**< Attempt to read empty NCZarr map key */
#define NC_EOBJECT (-140) /**< Some object exists when it should not */
#define NC_ENOOBJECT (-141) /**< Some object not found */
#define NC_EPLUGIN (-142) /**< Unclassified failure in accessing a dynamically loaded plugin> */

I'd gladly try to make a PR but, well, I'm not sure how/where the docs are generated, so I wasn't sure where to make a PR. I mean I see that there is a file:

https://github.com/Unidata/netcdf-c/blob/main/docs/all-error-codes.md

but I'm not sure if the doxygen is built from that because of things like #2336 and #2531 ? My search-fu on the repo's PRs has failed me.

@WardF WardF self-assigned this Jan 9, 2025
@WardF WardF added this to the 4.9.3 milestone Jan 9, 2025
WardF added a commit to WardF/netcdf-c that referenced this issue Jan 9, 2025
@WardF
Copy link
Member

WardF commented Jan 9, 2025

Thanks! I've updated this and added a little note to help remember to expand all-error-codes.md in the future, as we expand the error definitions in netcdf.h.

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

Successfully merging a pull request may close this issue.

2 participants