leanprover / leanprover/reference-manual
Unescaped Markdown
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 129
- Forks
- 67
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 16
Description
The documentation for the option pp.mvars includes:
(pretty printer) display names of metavariables when true, and otherwise display them as '?_' (for expression metavariables) and as '_' (for universe level metavariables)
Except it's actually rendered as:
(pretty printer) display names of metavariables when true, and otherwise display them as '?' (for expression metavariables) and as '' (for universe level metavariables)
Because the _ characters are unescaped and interpreted as Markdown italics.
While this text can be found here in the docs, the source that needs to be fixed is actually in (multiple???) other repos.
Contributor guide
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
Start with the linked Reading Proof States documentation section and trace the pp.mvars text back to its source repository or repositories. Confirm where the Markdown is generated or authored, then ensure the underscores render literally as ?_ and _ in the published documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100