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

Lambda package docs incorrectly link to compiler-libs instead of the lambda library #1294

Closed
edwintorok opened this issue Jan 26, 2025 · 1 comment

Comments

@edwintorok
Copy link

Following the docs link on this package https://ocaml.org/p/lambda/latest/doc/index.html
leads here: https://ocaml.org/p/ocaml-base-compiler/5.1.1/doc/Lambda/index.html

Which is the Lambda module in compiler-libs, not the Lambda module in the lambda library!

This is what that library actually contains: https://dakk.github.io/lambda/lambda/Lambda/index.html

I'm assuming that page is generated by odoc or a related tool, sorry if I opened this in the wrong place.

@jonludlam
Copy link
Member

Thanks for the report Edwin! I believe this will be fixed by the new odoc driver that will soon be used to generate the docs on ocaml.org. In fact you can see this by looking at a preview of the raw data that ocaml.org will be using to render the pages: http://5.102.169.186:8888/p/lambda/0.1.7/doc/

FYI the problem is almost a consequence of the current (odoc 2.4) layout, where we don't try separate the libraries of a package at all - so in the case of ocaml-base-compiler, the unwrapped modules of compiler-libs are all in the same place as stdlib, and it looks like in this case odoc has picked up the lambda module from there by mistake.

In odoc 3, we try much harder to separate modules by library, so this problem won't arise - ie, adding stdlib to the search path will no longer add all the compiler-libs modules. The Lambda module from compiler libs is here: http://5.102.169.186:8888/p/ocaml-base-compiler/5.2.0/doc/compiler-libs.common/Lambda/index.html - so you can see that, in comparison with the URL you posted above, there's an extra directory compiler-libs.common in there

The beta of odoc 3 has been merged to opam repository, so you can see the difference by installing odoc-driver and running odoc_driver lambda.

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

No branches or pull requests

2 participants