-
Notifications
You must be signed in to change notification settings - Fork 347
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
Cleanup for document filenames #528
Comments
That might be the occasion to only expose the current official API with modules without prefix or suffix (moving |
Renaming |
Yes I agree this is a mess. Will be working to make this more consistent. Here is my current plan. Let me know if any pieces of this don't make sense.
If all goes to plan this means that in the 1.0 release we have:
Where * means that this is just bindings for a JS module or JS functionality. Reason* means that the module carries a Reason runtime. |
In OCaml libraries, I follow these rules: A single library provides a single namespace, which we realize in OCaml with a module. So there is a single top-level module. Everything else goes under this module. Usually, the top-level module consists strictly of sub-modules, not values or types, i.e. we use
Sorry, I didn't understand this. Perhaps it invalidates some of my above points. |
This got eventually much better on 0.11, and can be improved with dune. There's a bit of room for improvement (fe. ReactEvent -> React.Event) which can happen at some point but those breaking changes are hard to sync and bring not much benefit rather than organisation. |
I'm still unclear on the file names. We have
ReasonReact.re
andReact.re
, andReactEvent.re
andReactEventRe.re
. I'm not sure what theReason*
prefix and*Re
suffix indicate if anything. If there is a pattern to the naming, it would be helpful to explain that in theREADME
. Or if the naming is actually inconsistent, then it would be nice to fix it.The text was updated successfully, but these errors were encountered: