Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a way to tell leanink to generate comments on #eval, #check commands #29

Open
lovettchris opened this issue Aug 30, 2022 · 2 comments

Comments

@lovettchris
Copy link
Contributor

Description

Readers are saying always visible comments are more readable than the little bubbles we are adding to eval statements. So we should make this an option when generating leanink books, like the new chapter on monads.

Detailed behaviour

Even better if we can do what David is doing in his functional programming in Lean book, which is to also write the "expected" values in the book so that the tool can then verify if that is what it is seeing when evaluating the code, so it can report errors if it finds a difference. This way the book author can verify the new values, rather than blindly posting something that might be entirely an error caused by some breaking change in the Lean compiler.

Testscenarios

References

@leodemoura
Copy link
Member

leodemoura commented Aug 30, 2022

I think the problem is not the bubble, but the fact that their content is not visible by default.
The bubbles look great to me, the problem is that we have to hover or click them to see the content.

@Kha
Copy link
Member

Kha commented Aug 31, 2022

See https://github.com/cpitclaudel/alectryon#controlling-output and https://github.com/cpitclaudel/alectryon#output-assertions. Alectryon has a ton of annotations like this, which we will have to reimplement if we don't want to go through it and docutils.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants