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

Partially de-duplicate signatures contained in irmin.mli #926

Merged
merged 3 commits into from
Jan 16, 2020

Conversation

craigfe
Copy link
Member

@craigfe craigfe commented Jan 16, 2020

This is a first attempt at inlining the duplicated signatures in Irmin core.
Mostly consists of pushing documentation from irmin.mli to s.ml or
<filename>.mli, and making the alias explicit in irmin.mli:

module type APPEND_ONLY_STORE = sig ... end

(* becomes *)
module type APPEND_ONLY_STORE = S.APPEND_ONLY_STORE

There are three API changes here:

  • exposing Type.pp_ty, which was previously unused;

  • removing Info.with_message, also unused;

  • exposing Merge.with_conlict, which was used internally but not exposed in
    the public signature. I feel as though we might as well provide this.

@craigfe
Copy link
Member Author

craigfe commented Jan 16, 2020

I processed the documentation with OCamlformat's parse-docstrings while I was moving it, so a side-benefit of this is that we get much smaller diffs if we ever adopt that option or if it becomes conventional. /cc. @Julow

@pascutto
Copy link
Contributor

I processed the documentation with OCamlformat's parse-docstrings while I was moving it, so a side-benefit of this is that we get much smaller diffs if we ever adopt that option or if it becomes conventional. /cc. @Julow

Yes, let's use this!

Copy link
Member

@samoht samoht left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM (I've just noticed a weird comment attachement)

And yes, let's use auto-formating in the comments too.

@craigfe craigfe force-pushed the split-documentation branch from 2db2bb0 to abd91f4 Compare January 16, 2020 16:17
@craigfe
Copy link
Member Author

craigfe commented Jan 16, 2020

I've added changelog entries for the newly-exposed functions Type.pp_ty and Merge.with_conflict.

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

Successfully merging this pull request may close these issues.

3 participants