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

Standardise return types #85

Open
grimbough opened this issue May 12, 2021 · 0 comments
Open

Standardise return types #85

grimbough opened this issue May 12, 2021 · 0 comments

Comments

@grimbough
Copy link
Owner

grimbough commented May 12, 2021

The return types for many of the H5X are all over the place. In most cases they return the same as the equivalent C function i.e. 0 for success (e.g. H5Aclose) , other times they return TRUE for success (e.g. H5Aexists).

This is compounded by cases where the return type and documentation do not match e.g. h5errorHandling returns NULL under all circumstances, but the docs say "Returns 0 if options are set successfully." This has been reported before in #43

This should be standardised across the package, and the documentation updated to reflect the new style. However it's unknown whether there are many instances where the return types are used by dependent packages. Changing 0 to TRUE will be a breaking change, so care needs to be taken before rolling this out.

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

No branches or pull requests

1 participant