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

comment profinite example #121

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

comment profinite example #121

wants to merge 1 commit into from

Conversation

kbuzzard
Copy link
Member

I've added a lot of comments for the profinite example 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.

@adamtopaz
Copy link
Collaborator

adamtopaz commented Aug 27, 2022

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...

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

Successfully merging this pull request may close these issues.

2 participants