`"&"` in docstring of `Html.text` is not rendered literally
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 384
- Forks
- 124
- Avg merge
- 22h 28m
- Merged PRs (30d)
- 10
Description
In the docstring of Html.text in src/verso/Verso/Output/Html.lean:
If `escape` is `true`, then characters such as `'&'` are escaped
to entities such as `"&"` during rendering.
At https://verso.lean-lang.org/doc/latest/Output-Formats/#Verso___Output___Html___text, the "&" is appears as "&". Expected: "&".
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect the Html.text docstring in src/verso/Verso/Output/Html.lean and compare it with the generated page at the linked documentation URL. Update the docstring so the "&" example is rendered literally, then regenerate or review the documentation to confirm the displayed text is correct.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 82/100