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 in trunk produces multiple copies of a title #7075

Closed
vicuna opened this issue Dec 4, 2015 · 6 comments
Closed

Ocamldoc in trunk produces multiple copies of a title #7075

vicuna opened this issue Dec 4, 2015 · 6 comments
Assignees
Milestone

Comments

@vicuna
Copy link

@vicuna vicuna commented Dec 4, 2015

Original bug ID: 7075
Reporter: @johnwhitington
Assigned to: @lpw25
Status: closed (set by @damiendoligez on 2016-02-03T16:19:20Z)
Resolution: fixed
Priority: normal
Severity: minor
Target version: 4.03.0+dev / +beta1
Fixed in version: 4.03.0+dev / +beta1
Category: documentation
Has duplicate: #7087
Related to: #6964

Bug description

For example, in Pervasives. See attached screenshot.

The problem is not in the source file. The problem does not occur in 4.02.3.

File attachments

@vicuna
Copy link
Author

@vicuna vicuna commented Dec 4, 2015

Comment author: @dbuenzli

This the same as #6964

@vicuna
Copy link
Author

@vicuna vicuna commented Dec 4, 2015

Comment author: @johnwhitington

If the documentation here...

http://caml.inria.fr/pub/docs/manual-ocaml/libref/Pervasives.html

...was generated by an OCamldoc shipped with 4.02.3, then this bug shows a regression from 4.02.3 to current trunk.

Whereas 0006964 is marked as being present in 4.02.3.

@vicuna
Copy link
Author

@vicuna vicuna commented Dec 4, 2015

Comment author: @dbuenzli

I would say this is not the case: the documentation comment structure changed:

git blame pervasives.mli
[...]
19a5d5e (Gabriel Scherer 2015-04-12 18:44:59 +0000 1004) (** {6 Result type} )
19a5d5e (Gabriel Scherer 2015-04-12 18:44:59 +0000 1005)
19a5d5e (Gabriel Scherer 2015-04-12 18:44:59 +0000 1006) type ('a,'b) result = Ok of 'a | Error of 'b
1a4be86 (Xavier Leroy 2003-07-05 11:13:24 +0000 1007)
6df4c2b (Pierre Weis 2002-10-31 10:00:02 +0000 1008) (
* {6 Operations on format strings} *)

@vicuna
Copy link
Author

@vicuna vicuna commented Dec 12, 2015

Comment author: @Octachron

As another data point, 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 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

@vicuna
Copy link
Author

@vicuna vicuna commented Dec 13, 2015

Comment author: @Octachron

I have proposed a fix for these problems on #348. The pull request also fixes the (/) issue on the example reported by dbuenzli in #6964.

@vicuna
Copy link
Author

@vicuna vicuna commented Feb 3, 2016

Comment author: @damiendoligez

fixed by #348 (#348)

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