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

Compiler internals exported as standard library modules in documentation #7247

Closed
vicuna opened this issue May 2, 2016 · 3 comments

Comments

Projects
None yet
2 participants
@vicuna
Copy link

commented May 2, 2016

Original bug ID: 7247
Reporter: rbonichon
Assigned to: @Octachron
Status: resolved (set by @Octachron on 2018-09-12T08:00:39Z)
Resolution: fixed
Priority: normal
Severity: minor
Version: 4.03.0
Fixed in version: 4.08.0+dev/beta1/beta2
Category: documentation
Related to: #7825

Bug description

It seems as if too many modules were exported for the documentation of 4.03 of the new release. I am not sure it qualifies as a bug but it does not feel right to me.

Comparing
http://caml.inria.fr/pub/docs/manual-ocaml-4.02/libref/index.html

with
http://caml.inria.fr/pub/docs/manual-ocaml-4.03/libref/

gives an idea of the differences.

For example, I am not sure one wants Identifiable or Syntaxerr to be documented in libref.

If they indeed must be exported, it might be better to show these modules on another dedicated page.

@vicuna

This comment has been minimized.

Copy link
Author

commented May 2, 2016

Comment author: @gasche

I agree this looks like a bug, and Damien might want to fix this relatively soon.

@vicuna

This comment has been minimized.

Copy link
Author

commented Jun 9, 2017

Comment author: @damiendoligez

This libref/index.html file contains not only the stdlib but also all the otherlibs, and (now) the compiler-libs.

Note that AFAIK it isn't part of the documentation proper, since it isn't linked from the main documentation.

At any rate, this change was introduced by @gasche in commit fd21a80 so I'll let you guys decide whether it's a bug and how to fix it.

@vicuna

This comment has been minimized.

Copy link
Author

commented Sep 12, 2018

Comment author: @Octachron

The PR, #2017, split the index between compilerlibref/index.html (for compiler-libs) and libref/index.html. The reported issue shoud thus be fixed in the next release of the manual.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.