leanprover / leanprover/reference-manual
confusing wording of "tail position" description
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 129
- Forks
- 67
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 16
Description
Describe the error
The wording describing what "tail position" means is confusing.
Quote
An expression is in tail position in the function body if it is:
Why is it incorrect and/or confusing?
The wording starts out as "an expression is in tail position if it has one of the following properties", resulting in a disjunctive enumeration, while it ends in a conjunctive enumeration (as evidenced by the word "and" as well as the use of plural.)
I would suggest one of the following options:
option 1 (disjunctive list of conditions)
An expression is in tail position in the function body if it is:
option 2 (conjunctive list of all options)
The following kinds of expression are in tail position:
note that with option 2, "in the function body" is removed from the header of the list. I couldn't find a nice wording that keeps that bit, but as a result i'm not sure that the meaning is as clear and/or still correct. If i am the person writing the PR for this, i will want a second opinion (other than myself), as i am not a native speaker.
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 quoted tail-position passage and compare its list structure with the surrounding explanation and linked match and if documentation. Choose a consistent singular or plural wording, preserve the intended meaning, and confirm that the revised passage reads clearly in context.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100