search

thizanne / ocaml-hamt

Implementation of the Hash Array Mapped Trie data structure in OCaml
MIT License
13 stars 0 forks source link

Implement API changes to align with published 1.0.0 package #8

Closed Leonidas-from-XIV closed 4 years ago

Leonidas-from-XIV commented 4 years ago

As @thizanne wanted to keep the API of the released OPAM package this commit is cherry-picking the changes by @rgrinberg to the public API.

Personally I do like marking things that throw _exn but not all of them do. So for a future (2.0.0?) release I would go ahead and rename all the throwing functions into _exn and move the ExceptionLess module to the top-level.

But for now this should implement exactly the same API as hamt.1.0.0 on OPAM so it should be possible to release it as e.g. hamt.1.0.1 without breaking changes.

thizanne commented 4 years ago 
thibault@manta \_o< opam list -A --depends-on=hamt --recursive
# Packages matching: any & rec-depends-on(hamt)
# Name # Installed # Synopsis
hamt   --          Hash Array Mapped Tries

Note that we can afford not to be too concerned about breaking compat :-) But well, since we're (you're, mostly, thanks for that) doing a bit of cleaning, maybe it doesn't hurt to do as you propose and push some facelifted version on opam.

After that, as far as I'm concerned, 2.0.0 can go out as early as you wish, were it to simply provide you a cleaner API for your personal use...