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

Remove duplication in .mlis, expose MarshalError, add docs #115

Merged
merged 1 commit into from
Jun 14, 2018
Merged

Remove duplication in .mlis, expose MarshalError, add docs #115

merged 1 commit into from
Jun 14, 2018

Conversation

gaborigloi
Copy link
Collaborator

Fixes #87

Signed-off-by: Gabor Igloi [email protected]

@gaborigloi
Copy link
Collaborator Author

We should also deduplicate the implementations themselves at one point, but that will be much harder.

@gaborigloi gaborigloi requested a review from mseri June 14, 2018 14:27
@gaborigloi
Copy link
Collaborator Author

It would also be nice to upload the docs automatically somewhere.

@mseri
Copy link
Collaborator

mseri commented Jun 14, 2018

I agree on both comments :)

Copy link
Collaborator

@mseri mseri left a comment

Choose a reason for hiding this comment

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

There is something weird in the docstrings indentations. Overall it looks great, thanks!

src/lib/idl.mli Outdated
val (@->) : 'a Param.t -> 'b fn -> ('a -> 'b) fn
val returning : 'a Param.t -> 'b Error.t -> ('a, 'b) comp fn
val declare : string -> string list -> 'a fn -> 'a res
Then we can the server itself can be obtained by passing the [implementation]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Little typo: ‘Then the server itself’...

@mseri
Copy link
Collaborator

mseri commented Jun 14, 2018

I think we could use the associated github pages for the documentation

@mseri
Copy link
Collaborator

mseri commented Jun 14, 2018

Tomorrow I’ll play with dune-release and do a deserved upstream release and announce

@gaborigloi
Copy link
Collaborator Author

Thanks for the review, fixed the issues.
That sounds great, thanks!
I was wondering, should we split out more opam packages first, to avoid having a second breaking release afterwards? Because if we do #101 then we'll introduce the angstrom dependency (probably, if there isn't an ocamldoc parser already available), and then it'd be nice to add this extra dependency to a separate opam package, instead of making rpclib heavier.

@gaborigloi gaborigloi merged commit 0521514 into mirage:master Jun 14, 2018
@gaborigloi gaborigloi deleted the doc branch June 14, 2018 15:47
@mseri
Copy link
Collaborator

mseri commented Jun 14, 2018

I am still not sure ablut parsing ocamldoc by hands though

@mseri
Copy link
Collaborator

mseri commented Jun 14, 2018

And I think it would be a minimal disruption anyways

@mseri
Copy link
Collaborator

mseri commented Jun 14, 2018

I was starting to set-up the auto push but I don’t have enough privileges to setup github pages. @jonludlam can you increase my privileges or do it for us?

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.

2 participants