-
Notifications
You must be signed in to change notification settings - Fork 42
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
feat: html escape docstrings #157
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Unfortunately this PR breaks the Could you explain why this was needed (as of Oct. 2023)? Seems that currently it's not needed anymore in your example. I checked the git history of that file in Oct. 2023, and have no idea why it was needed at that time (perhaps because old version of doc-gen4 throws the declaration itself to markdown processor?) |
Check out
https://web.archive.org/web/20230325075237/https://leanprover-community.github.io/mathlib4_docs/Mathlib/Order/ConditionallyCompleteLattice/Basic.html#ciSup_le
and scroll around a bit. Some parts of the page have completely broken
formatting.
…On Fri, 7 Jun 2024, 10:39 Jz Pan, ***@***.***> wrote:
Unfortunately this PR breaks the <url> parsing in markdown.
Could you explain why this was needed (as of Oct. 2023)? Seems that
currently it's not needed anymore in your example. I checked the git
history of that file in Oct. 2023, and have no idea why it was needed at
that time (perhaps because old version of doc-gen4 throws the declaration
itself to markdown processor?)
—
Reply to this email directly, view it on GitHub
<#157 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAM4HVKETW4Y4Y6REWDCJ33ZGF5T3AVCNFSM6AAAAABI6KJXQCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNJUGQ3TIOBZGQ>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
I see. Seems that some code blocks are randomly duplicated. But I'm not sure this is related to the unescape thing. On the other hand, we come up with another solution https://leanprover.zulipchat.com/#narrow/stream/113488-general/topic/Contribution.20to.20doc-gen4.3F/near/443537944. It turns out that Lean.Xml.instToStringElement is not appropriate here (or perhaps it's buggy leanprover/lean4#4411). Could you have a loot on it? |
Unfortunately I don't have time to look at the moment. But if you have an implementation that you've tested works fine on this page and others that have |
also fix the escape codes
see https://leanprover-community.github.io/mathlib4_docs/Mathlib/Order/ConditionallyCompleteLattice/Basic.html#ciSup_le for examples of why this is needed