Skip to content

Commit

Permalink
doc: Add a docstring to Simp.Result and its fields (#3319)
Browse files Browse the repository at this point in the history
  • Loading branch information
eric-wieser authored Feb 13, 2024
1 parent 3a6ebd8 commit 0554ab3
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/Lean/Meta/Tactic/Simp/Types.lean
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,13 @@ import Lean.Meta.Tactic.Simp.SimpCongrTheorems
namespace Lean.Meta
namespace Simp

/-- The result of simplifying some expression `e`. -/
structure Result where
/-- The simplified version of `e` -/
expr : Expr
proof? : Option Expr := none -- If none, proof is assumed to be `refl`
/-- A proof that `$e = $expr`, where the simplified expression is on the RHS.
If `none`, the proof is assumed to be `refl`. -/
proof? : Option Expr := none
/-- Save the field `dischargeDepth` at `Simp.Context` because it impacts the simplifier result. -/
dischargeDepth : UInt32 := 0
/-- If `cache := true` the result is cached. -/
Expand Down

0 comments on commit 0554ab3

Please sign in to comment.