This PR improves the error message encountered in the case of a type class instance resolution failure, and adds an error explanation that discusses the common new-user case of binary operation overloading and points to the `trace.Meta.synthInstance` option for advanced debugging. ## Example ```lean4 def f (x : String) := x + x ``` Before: ``` failed to synthesize HAdd String String ?m.5 Hint: Additional diagnostic information may be available using the `set_option diagnostics true` command. ``` After: ``` failed to synthesize instance of type class HAdd String String ?m.5 Hint: Type class instance resolution failures can be inspected with the `set_option trace.Meta.synthInstance true` command. Error code: lean.failedToSynthesizeTypeclassInstance [View explanation](https://lean-lang.org/doc/reference/latest/find/?domain=Manual.errorExplanation&name=lean.failedToSynthesizeTypeclassInstance) ``` The error message is changed in three important ways: * Explains *what* failed to synthesize, using the "type class" terminology that's more likely to be recognized than the "instance" terminology * Points to the `trace.Meta.synthInstance` option which is otherwise nearly undiscoverable but is quite powerful (see also leanprover/reference-manual#663 which is adding commentary on this option) * Gives an error explanation link (which won't actually work until the next release after this is merged) which prioritizes the common-case explanation of using the wrong binary operation
39 lines
1.2 KiB
Text
39 lines
1.2 KiB
Text
import Lean
|
|
open Lean Elab Tactic
|
|
|
|
macro "obviously1" : tactic => `(tactic| exact sorryAx _ false)
|
|
|
|
theorem result1 : False := by obviously1
|
|
|
|
elab "obviously2" : tactic =>
|
|
liftMetaTactic1 fun mvarId => mvarId.admit *> pure none
|
|
|
|
theorem result2 : False := by obviously2
|
|
|
|
/--
|
|
error: failed to synthesize instance of type class
|
|
OfNat Bool 0
|
|
numerals are polymorphic in Lean, but the numeral `0` cannot be used in a context where the expected type is
|
|
Bool
|
|
due to the absence of the instance above
|
|
|
|
Hint: Type class instance resolution failures can be inspected with the `set_option trace.Meta.synthInstance true` command.
|
|
-/
|
|
#guard_msgs in
|
|
def x : Bool := 0
|
|
|
|
theorem result3 : False := by obviously2
|
|
|
|
/--
|
|
error: failed to synthesize instance of type class
|
|
OfNat Bool 0
|
|
numerals are polymorphic in Lean, but the numeral `0` cannot be used in a context where the expected type is
|
|
Bool
|
|
due to the absence of the instance above
|
|
|
|
Hint: Type class instance resolution failures can be inspected with the `set_option trace.Meta.synthInstance true` command.
|
|
-/
|
|
#guard_msgs in
|
|
theorem result4 : False := by -- Does not generate a `sorry` warning because there is an error
|
|
let x : Bool := 0
|
|
obviously2
|