Skip to content

Inline raise tag content in HTML rendering.#1440

Open
Tim-ats-d wants to merge 1 commit into
ocaml:masterfrom
Tim-ats-d:issue1136
Open

Inline raise tag content in HTML rendering.#1440
Tim-ats-d wants to merge 1 commit into
ocaml:masterfrom
Tim-ats-d:issue1136

Conversation

@Tim-ats-d
Copy link
Copy Markdown

The fix is a bit ugly (l.attr = [ "raises"]) but I can easily remove this part by adding a field should_inline in the record definition of the type of Odoc_document.Types.Description.t to avoid relying on a fragile string comparison.

Should fix theses two issues:

cc @panglesd

@panglesd
Copy link
Copy Markdown
Collaborator

The current fix has several issues:

  • It only deals with the html backend: the other backend still have the issue.
  • (If I understand correctly your code, did not check) It basically turns all paragraphs inside a raise tag into span, removing all the paragraph styling. So multi-paragraph raise tags are broken!
  • Yes, the string comparison is not something we want.

I think it would be much cleaner to fix that in "Document", by putting the tag inside the first paragraph (if there is one, creating a paragraph otherwise). I think that would fix the problems I mentioned above!

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 this pull request may close these issues.

2 participants