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

DynArray interface documentation #984

Closed
UnixJunkie opened this issue Nov 13, 2020 · 5 comments
Closed

DynArray interface documentation #984

UnixJunkie opened this issue Nov 13, 2020 · 5 comments

Comments

@UnixJunkie
Copy link
Member

since tags are missing for many new functions

@UnixJunkie
Copy link
Member Author

the interface is probably not synchronized with the implementation regarding the type of exception thrown in each case

@UnixJunkie
Copy link
Member Author

@andrep @fccm

@fccm
Copy link
Member

fccm commented Nov 19, 2020

Half of the functions from this module raise Pervasives.Invalid_arg, and the others DynArray.Invalid_arg.
Maybe we could uniformise it.
Then which one would you prefer to keep?

@UnixJunkie
Copy link
Member Author

The problem is that this is a breaking change.
Old functions which were already throwing an exception should not have its type changed.
If recently introduced functions introduced Pervasives.invalid_arg, it would be better if we stick to the exception
that was already present in the module (DynArray.Invalid_arg).

@UnixJunkie
Copy link
Member Author

thanks to @fccm

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

2 participants