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

feat: html escape docstrings #157

Merged
merged 2 commits into from
Oct 16, 2023
Merged

Conversation

alexjbest
Copy link
Contributor

@alexjbest alexjbest commented Oct 16, 2023

Copy link
Collaborator

@hargoniX hargoniX left a comment

Choose a reason for hiding this comment

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

Thanks!

@hargoniX hargoniX merged commit 5b4d779 into leanprover:main Oct 16, 2023
1 check passed
@acmepjz
Copy link
Contributor

acmepjz commented Jun 7, 2024

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?)

@alexjbest
Copy link
Contributor Author

alexjbest commented Jun 7, 2024 via email

@acmepjz
Copy link
Contributor

acmepjz commented Jun 9, 2024

Some parts of the page have completely broken formatting.

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?

@alexjbest
Copy link
Contributor Author

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 < characters in it's probably fine.

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.

3 participants