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

short description of compiler-libs modules #7546

Closed
vicuna opened this issue Jun 4, 2017 · 2 comments

Comments

Projects
None yet
2 participants
@vicuna
Copy link

commented Jun 4, 2017

Original bug ID: 7546
Reporter: @Octachron
Assigned to: @Octachron
Status: resolved (set by @Octachron on 2018-09-12T07:53:07Z)
Resolution: fixed
Priority: low
Severity: feature
Fixed in version: 4.08.0+dev/beta1/beta2
Category: documentation
Tags: junior_job

Bug description

Numerous modules which are part of the compiler library appear in the manual library index at http://caml.inria.fr/pub/docs/manual-ocaml/libref.

It would help the readability of this index if

  • all modules had a short description
  • the short description of every module of the compiler-libs started with a "Compiler-libs:" or equivalent prefix.

Note that this short description of module is extracted from the first sentence of the first documentation comment in the module ".mli" file.

@vicuna

This comment has been minimized.

Copy link
Author

commented Jun 4, 2017

Comment author: @gasche

Note to any potential contributor: to see the effects of a change to the library documentation, you can run from the repository checkout:

make html_doc
firefox ./ocamldoc/stdlib_html/index.html # or your favorite browser
@vicuna

This comment has been minimized.

Copy link
Author

commented Sep 12, 2018

Comment author: @Octachron

Fixed by #2020 .

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.