CategoryDocstringLinter.lean`

Explanation legend Lean4 Domain Explanation Language (L4DEL)

L4DEL explanations are a separate layer. They do not change the Lean source. Intuition is explanatory prose; numbered items are a reading path; sources link the wording back to evidence.

L4DEL: Lean4 Domain Explanation Language

Annotation provenance. This overlay contains 10 curated AI-written annotations and 7190 mechanical source-derived annotations. They have not been human-reviewed as explanations; treat them as unverified and not mathematical authority. Retained generation history: The 71 original curated annotations were produced in a Claude Sonnet 5.5 session at medium effort; Claude Opus 5.5 is recorded in that session as the advisor model, not the direct author. The bulk source-derived expansion was generated mechanically from pinned source comments by tooling developed in a GPT-5.6 Sol session at ultra reasoning; GPT-5.6 Sol did not originate the quoted source prose. On 2026-10-17 the mechanically generated source-comment annotations of the Formal Conjectures, Carleson, FLT, PFR, CompFiles, Mathematics in Lean and Theorem Proving in Lean overlays were regenerated by the same generator after three corrections made in a Claude Sonnet 5.5 session: titles no longer cut a sentence inside mathematics or end on a dangling word, workflow markers are removed from the quoted prose, and declaration names follow the scanner's namespace resolution. The boilerplate step line was dropped, and comments that were only a row of dashes no longer yield annotations. No new prose was written and no human review is claimed.

Credit: The upstream authors and contributors retain credit for the project and mathematics. lean4-explainer only renders their pinned source and adds the separately disclosed explanation layer.

Project sources: Pinned project documentation, Formal Conjectures paper, arXiv v1

3 declarations, 0 contain sorry, 0 declared as axioms

The Category Docstring Linter

The CategoryDocstringLinter ensures that declarations tagged as @[category research open], @[category research solved], or @[category textbook] have a docstring.

Imports (2)

Imported by 2 files

def CategoryDocstringLinter.categoryNeedsDocstring Whether the given category requires a docstring line 39 source
Source documentation
Whether the given category requires a docstring.

standard axioms: propext what this means
Statement uses: ProblemAttributes.Category, Bool
Proof uses: Unit, Bool.true, Bool.false
1 instances, coercions and auxiliary constants left out.
```
def categoryNeedsDocstring : ProblemAttributes.Category → Bool
  | .research .open | .research .solved | .textbook => true
  | _ => false

/-- Whether the declaration modifiers contain a docstring. -/
```
Mentions: ProblemAttributes.Category
def CategoryDocstringLinter.hasDocstring Whether the declaration modifiers contain a docstring line 44 source
Source documentation
Whether the declaration modifiers contain a docstring.

standard axioms: propext what this means
Statement uses: Lean.TSyntax, List.cons, Lean.SyntaxNodeKind, Lean.Name.mkStr4, List.nil, Bool
Proof uses: Lean.Syntax, GetElem?.getElem!, Nat, True, Lean.TSyntax.raw, OfNat.ofNat, Bool.not, String.isEmpty, Lean.Syntax.getAtomVal
5 instances, coercions and auxiliary constants left out.
```
def hasDocstring (stx : TSyntax ``Command.declModifiers) : Bool :=
…
```
def CategoryDocstringLinter.categoryDocstringLinter The linter checking for docstrings on research statements line 49 source
Source documentation
The linter checking for docstrings on research statements.

standard axioms: Classical.choice, Quot.sound, propext what this means
Statement uses: Lean.Elab.Command.Linter
Proof uses: Lean.Elab.Command.Linter.mk, Lean.withSetOptionIn, Lean.Syntax, ite, Lean.Elab.Command.CommandElabM, Unit, Eq, Bool, Lean.Syntax.isOfKind, Lean.Name.mkStr4, Bool.true, Lean.Syntax.getArg, OfNat.ofNat, Nat, cond, Bool.or, Bool.false, Lean.TSyntax, List.cons, Lean.SyntaxNodeKind and 31 more
13 instances, coercions and auxiliary constants left out.
```
def categoryDocstringLinter : Linter where
…
```