leanprover / leanprover/reference-manual

convenience macros for complex expressions

Open
#303 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

Mentioning “match expression” or “if-then-else expression” is rather tedious and verbose:

{keywordOf Lean.Parser.Term.match}`match` expression
{keywordOf termIfThenElse}`if`-{keywordOf termIfThenElse}`then`-{keywordOf termIfThenElse}`else`-expression

To keep it easy to use and consistent it would be nice to have a simple macro (singular and plural) for such things. This is technically not hard, I presume, but more a question of where to put them and what the syntax could be. Maybe {pretty}[match expression] or {abbrev}[match expression] or something like that?

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

The issue names no files, tests, or entry points. Start by locating the existing reference-manual macro definitions and their usage patterns, then decide the syntax and placement for singular and plural convenience macros. Done means the syntax is agreed and the macros consistently shorten the cited match and if-then-else expressions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.