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

Missing documentation for Base.Monad and Base Applicative #73

Closed
XVilka opened this issue May 21, 2019 · 3 comments
Closed

Missing documentation for Base.Monad and Base Applicative #73

XVilka opened this issue May 21, 2019 · 3 comments
Labels
forwarded-to-js-devs This report has been forwarded to Jane Street's internal review system.

Comments

@XVilka
Copy link

XVilka commented May 21, 2019

Basically zero information on these modules:

https://ocaml.janestreet.com/ocaml-core/latest/doc/base/Base/Monad/index.html

https://ocaml.janestreet.com/ocaml-core/latest/doc/base/Base/Applicative/index.html

@yminsky
Copy link
Contributor

yminsky commented May 21, 2019

This is at least in part due to deficiencies in odoc (which are currently being worked on by Jon Ludlum at OCaml Labs!). Here's the interface file, which has at least a modicum of documentation:

https://github.com/janestreet/base/blob/master/src/monad_intf.ml

Some of this is simply lost by the documentation processor, like the toplevel module comment. Some of it is present in internal nodes after too many layers of indirection.

I don't think there's anything to do here until the odoc fixes land.

@XVilka
Copy link
Author

XVilka commented May 21, 2019

Oh, thanks, didn't notice it is a problem on odoc side.

@github-iron github-iron added the forwarded-to-js-devs This report has been forwarded to Jane Street's internal review system. label Sep 2, 2020
@seliopou
Copy link
Member

Documentation exists but is sadly not very discoverable due to ocaml doc. Folks on working on improvements in that project, so closing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
forwarded-to-js-devs This report has been forwarded to Jane Street's internal review system.
Projects
None yet
Development

No branches or pull requests

4 participants