leanprover / leanprover/reference-manual
hard to distinguish text from code
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 129
- Forks
- 67
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 16
Description
Inside the description boxes, text and code snippets are in my opinion almost indistinguishable. It would be nice if the code snippets could be formatted slightly differently, for example using colour.
Example
I've read this as
[...] like
"value = { and }"ins!"value = {x}"
and had to look at the source code to realise it's
[...] like
"value = {and}"ins!"value = {x}"
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 by reading the linked reference page and comparing the two attached screenshots with the displayed examples. Trace how description boxes render ordinary text and code snippets, then verify that the two are visually distinguishable without inspecting the source while preserving the documented examples.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100