leanprover / leanprover/reference-manual

Universe variables shown confusingly in example

Open
#354 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lean
Stars
129
Forks
67
Avg merge
1d 15h
Merged PRs (30d)
16

Description

From Zulip:

There are universe inconsistencies in the two examples in section 2.4. In the "Equational Lemmas" example we're shown some code with no universes mentioned, and the equational lemmas are peppered with references to universe u_1, except for thirdOfFive.eq_1 which is all about universe u. (except for when you hover, in which case you see u_1 again). Conversely the other example, "Recursive Equational Lemmas", again is a discussion about code written where no universes are mentioned, but all the equation lemmas use universe u consistently in the text (although all hovers talk about universe u_1). I don't know if this is confusing for new users, I guess my instinct is to make it consistent (and consistency within the first example would surely be desirable rather than thirdOfFive.eq_1 being the odd one out).

This should be fixed. It will require a bit of attention to the delaboration and pretty printing that gives rise to hovers.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the two examples in section 2.4, “Equational Lemmas” and “Recursive Equational Lemmas,” and compare their displayed universe variables with the hover information. Then inspect the delaboration and pretty printing that produce these displays. Done means the universe naming is consistent within and between the examples, including thirdOfFive.eq_1.

Written by the indexing model from the issue text.

Assessment

Domain
compilers, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.