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

Ocamldoc garbles scanf and pervasives modules documentation in ocaml manual #7087

Closed
vicuna opened this issue Dec 12, 2015 · 1 comment
Closed

Comments

@vicuna
Copy link

vicuna commented Dec 12, 2015

Original bug ID: 7087
Reporter: @Octachron
Assigned to: @gasche
Status: closed (set by @xavierleroy on 2017-02-16T14:18:11Z)
Resolution: duplicate
Priority: normal
Severity: text
Category: documentation
Duplicate of: #7075

Bug description

In trunk version, the documentation for the Scanf module ends up being completely scrambled. Section titles and entire subsections are repeated multiple times. For instance, I count no less than 8 repetitions of the "Introduction" section title. The pervasives module suffers from a less acute form of this problem. The problem seems to stem from the presence of consecutive sequences of separated documentation comments. Merging together these documentation comments remove the stuttering.

Moreover, there is also redoubled section title in the following module documentation

  • Ast_mapper
  • Bigarray
  • Random
    and some empty section titles in
  • Parsing
  • Lexing

Steps to reproduce

Build the ocaml manual from trunk and try to read the Stdlib/Scanf section.

@vicuna
Copy link
Author

vicuna commented Dec 12, 2015

Comment author: @gasche

This is a duplicate of 7075. Thanks for the detailed report, however: could you reproduce it as a comment there?

The issue is known and I think the obvious suspect is Leo (in his changes to integrate documentation comments in the compiler frontend), but I guess his plate is quite full with flambda stuff right no so we haven't seen much progress.

If you wanted to help, just bisecting which commit is responsible for this mess could be useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants