Conversation
Collaborator
|
I guess one question we need to answer is who the intended audience for these files actually is. My original intention was for these to be read by mathematicians who were already very familiar with the mathematics, so I saw the docs more as hints for how to translate the math into Lean's type theory. But I do agree that more detail probably won't hurt! Let see what others think... |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I've added a lot of comments for the
profiniteexample Lean file. My personal opinion from having watched students is that there are two kinds. There are those that don't read any of the documentation whether it be on a web page or in the file, and just start playing about. And there are those that want to carefully read docs and play with Lean at the same time, and for those people it's really annoying when the docs are on another page. I always put many many comments in my teaching material now, I think students find it easier, and VS Code makes it very clear what is a comment and what isn't.Obviously other people's views might differ; I don't think I'm going to plough through the other three example lean files until I've heard people's thoughts on this PR and #120.