-
Notifications
You must be signed in to change notification settings - Fork 262
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
Data out-of-date -- docs/all-error-codes.md #891
Comments
I wonder if we could build a tool using e.g. awk to automatically |
The error codes are actually poorly documented in netcdf.h. I suggest that we fix up the error documentation there. I don' t think that programmers will naturally look to a separate documentation file for information, so I think all-error-codes.md is perhaps not needed. |
A perhaps simple solution is to provide the documentation in the |
I believe we should remove all-error-codes.md, and in nc_strerror() we should simply refer to netcdf.h. In netcdf.h we should (as we already have) document each error code with a doxygen comment. If we do all this, doxygen will display the error codes just fine: I will submit a PR with this change. (Furthermore, when referring to these constants in the doxygen, we need to preceed them with a double-colon. Like If we do that then the error code will be hyper-linked to it's definition in netcdf.h.) |
Not sure if it matters, but discovered while grepping the code tree for an error code translation that the values in all-error-codes.md are incomplete and in some cases incorrect. For example
NC_EBADGRPID
is -116 in netcdf.h, but listed as -113 inall-error-codes.md
The text was updated successfully, but these errors were encountered: