leanprover-community / leanprover-community/leanprover-community.github.io

add type signatures to theorems demonstrating naming conventions

Open
#818 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
84
Forks
190
Avg merge
1d 12h
Merged PRs (30d)
12

Description

In https://leanprover-community.github.io/contribute/naming.html#identifiers-and-theorem-names , the following section

import Mathlib.Algebra.Order.Monoid.Lemmas
import Mathlib.Algebra.Order.Ring.Lemmas

open Nat

#check mul_pos
#check mul_nonpos_of_nonneg_of_nonpos
#check add_lt_of_lt_of_nonpos
#check add_lt_of_nonpos_of_lt

doesn't run on Lean 4 Web and locally.

It would much more ideal to have comments with type signatures showing what the theorem is about and why it was given this name so that if things get moved around/break the ideas regarding naming conventions still come across.

The above is one code block from that page , a similar thing can be done for the other code blocks

Contributor guide

No contributing guide indexed for this repository

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 at the identifiers-and-theorem-names section of the naming page and inspect each code block, beginning with the examples around mul_pos and add_lt_of_lt_of_nonpos. Check the examples in Lean 4 Web or locally, then add type-signature comments and naming explanations so the conventions remain understandable if theorem locations change.

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
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.