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
Comments
Comment author: @dbuenzli
In certain cases... |
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 (** {1 Title}
wil not. |
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. |
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. |
Comment author: @lpw25
I'll try to have a look at this before the release. |
Comment author: @damiendoligez |
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
val x : int
(** Hey bla *)
(/)
val y : int
val uf : int
(/)
(** {1 Bla} *)
val z : int
(** This is [z]. *)
The text was updated successfully, but these errors were encountered: