Skip to content

ocamldoc: no paragraphes in the table of modules - #14098

Merged
Octachron merged 1 commit into
ocaml:trunkfrom
Octachron:ocamldoc_no_paragraph_in_module_table
Jun 20, 2025
Merged

Octachron merged 1 commit into
ocaml:trunkfrom
Octachron:ocamldoc_no_paragraph_in_module_table

Conversation

@Octachron

Copy link
Copy Markdown
Member

This PR fixes #13896 by avoiding to wrap in a <p> tag the short module description inside the index table of modules.

@gasche gasche left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Passing with_p:bool deep down the call stack is not a very nice design (it's not clear and a bit convoluted), but this is already what the code before was doing for other things, so the tweak is consistent with the codebase. Approved.

@Octachron

Copy link
Copy Markdown
Member Author

Note that I am planning to cherry-pick this PR to 5.4 as an ocamldoc fix.

@Octachron
Octachron merged commit 19040f8 into ocaml:trunk Jun 20, 2025
Octachron added a commit that referenced this pull request Jun 23, 2025
Fix #13896: do not wrap short descriptions of modules in a <p> tag when inside a table.

(cherry picked from commit 19040f8)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

OCamldoc rendering in OCaml 5 worse than OCaml 4

2 participants