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

paragraphs merged inside itemize in ocamldoc html backend #9525

Closed
hendriktews opened this issue May 2, 2020 · 4 comments · Fixed by #10402
Closed

paragraphs merged inside itemize in ocamldoc html backend #9525

hendriktews opened this issue May 2, 2020 · 4 comments · Fixed by #10402

Comments

@hendriktews
Copy link
Contributor

ocamldoc documentation says that an empty line forces a new line. However, in the html output of

(**
   {ul
   {li a

       b
   }
   }
 *)
val c : (int, int) Hashtbl.t

a and b are on the same line.
Observed in 4.09 and 4.10.

@hendriktews
Copy link
Contributor Author

One can force a paragraph for html with

{%html: <p> %}

@github-actions
Copy link

github-actions bot commented May 5, 2021

This issue has been open one year with no activity. Consequently, it is being marked with the "stale" label. What this means is that the issue will be automatically closed in 30 days unless more comments are added or the "stale" label is removed. Comments that provide new information on the issue are especially welcome: is it still reproducible? did it appear in other contexts? how critical is it? etc.

@github-actions github-actions bot added the Stale label May 5, 2021
@hendriktews
Copy link
Contributor Author

hendriktews commented May 5, 2021 via email

@Octachron
Copy link
Member

The automatic formatting in paragraphs is indeed limited to the toplevel documentation comments and does not happen inside a formatting tag.

Since ocamldoc is in maintenance mode, I will update the documentation to more precisely reflect that point.

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

Successfully merging a pull request may close this issue.

2 participants