Zulip Chat Archive

Stream: lean4

Topic: doc for `notation`


Michael Stoll (Mar 01 2024 at 16:10):

Would it be possible to show some kind of docstring when hovering over notation? (Giving some explanation of the syntax and perhaps referring to Init.Notation for examples (the source code, the actual notation definitions do not show up on the HTML docs -- maybe this can be improved, too?)) Right now, exactly nothing happens when I move the mouse cursor on notation (in VSCode) in a .lean file.

Mario Carneiro (Mar 02 2024 at 06:08):

It will link to the source code for the notation parser, but only if you have it imported with import Lean

Mario Carneiro (Mar 02 2024 at 06:10):

The lack of documentation on commands is indeed a major issue. Unfortunately there aren't many people working on it, I've tried to do what I can but I don't have that much time to spend on it

Mario Carneiro (Mar 02 2024 at 06:11):

If you put /-- foo -/ docs on the syntax declaration it should show up in hovers (even if Lean is not imported). The problem is that no one put one on src#Lean.Parser.Command.notation


Last updated: May 02 2025 at 03:31 UTC