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 still loosing documentation #6964

Closed
vicuna opened this issue Aug 19, 2015 · 6 comments
Closed

ocamldoc still loosing documentation #6964

vicuna opened this issue Aug 19, 2015 · 6 comments

Comments

@vicuna
Copy link

vicuna commented Aug 19, 2015

Original bug ID: 6964
Reporter: @dbuenzli
Status: closed (set by @damiendoligez on 2016-02-03T16:17:38Z)
Resolution: fixed
Priority: normal
Severity: minor
Platform: macosx
Version: 4.02.3
Target version: 4.03.0+dev / +beta1
Fixed in version: 4.03.0+dev / +beta1
Category: ocamldoc
Related to: #7075
Monitored by: @gasche @diml @hcarty @dbuenzli

Bug description

Related to #6926. If there are things between (/) (/) everything that comes after is lost. In the example below the documentation for [z], value declaration included is inexistent. Note that removing the Bla heading makes the documentation for [z] reappear.

Steps to reproduce

cd /tmp
mkdir doc
cat bla.mli

val x : int
(** Hey bla *)

(/)
val y : int
val uf : int
(/)

(** {1 Bla} *)

val z : int
(** This is [z]. *)

ocamldoc -d doc -html bla.mli

@vicuna
Copy link
Author

vicuna commented Aug 19, 2015

Comment author: @dbuenzli

If there are things between (/) (/) everything that comes after is lost.

In certain cases...

@vicuna
Copy link
Author

vicuna commented Aug 20, 2015

Comment author: @dbuenzli

Also it exhibits stuttering output whenever two headers are followed one after the other without any content between the two headers.

(** {1 Title} *)

(** {1 Other title} *)

will output the header Title twice. While

(** {1 Title}

 {1 Other title} *)

wil not.

@vicuna
Copy link
Author

vicuna commented Nov 19, 2015

Comment author: @dbuenzli

Will something be done about this for 4.03 ? It's a very annoying bug that affects the quality of the documentation of the whole ecosystem.

@vicuna
Copy link
Author

vicuna commented Nov 19, 2015

Comment author: @gasche

You are indeed right than fixing those is important. (But I won't personally have time to work on this.)

It is not clear to me which part of the reports are likely old issues from the ocamldoc tools, and which are regression that may be caused, or at least made apparent, by Leo's change in 4.02.2. One way to help triaging similar issues in the future would be for you to try with both a post-Leo and a pre-Leo version of the compiler+ocamldoc, such as 4.02.3 and 4.01.0, and report whether both versions are affected.

@vicuna
Copy link
Author

vicuna commented Nov 19, 2015

Comment author: @lpw25

Will something be done about this for 4.03 ?

I'll try to have a look at this before the release.

@vicuna
Copy link
Author

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

1 participant