colis-anr / morbig

A static parser for POSIX Shell
Other
190 stars 8 forks source link

Rename `Morbig.API` → `Morbig`? #64

Closed Niols closed 5 years ago

Niols commented 5 years ago

Now that we compile with Dune, it's super easy to make all the functions of API directly accessible from the Morbig module. Morbig.API.parse_file would simply be Morbig.parse_file. The other modules would still be accessible naturally (Morbig.CST.program, for instance).

This can be a breaking change. Actually, this can also be done in a retro-compatible way (by providing access to this functions both directly in the Morbig module and in the Morbig.API module) but I'd rather take advantage of the fact that we are preparing breaking changes anyway to do this one.

I would personally vote for that and it's a matter of minutes (if not seconds) for me to do this change. What do you think, @treinen, @yurug?

treinen commented 5 years ago

Sounds good to me.

yurug commented 5 years ago

Please proceed!