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

remove comments on orientation def #6

Merged
merged 3 commits into from
Jun 10, 2024
Merged

Conversation

JamesGallicchio
Copy link
Collaborator

No description provided.

@digama0
Copy link
Collaborator

digama0 commented Jun 5, 2024

why?

@JamesGallicchio
Copy link
Collaborator Author

Reviewer 1 said that the comments were confusingly formatted (didn't realize they were comments at first) and unhelpful. I was going to just reformat it as

inductive Orientation
| cw        -- clockwise, det < 0
| ccw       -- counter clockwise, det > 0
| collinear

to clarify that they are comments, but I still find it not particularly helpful for readers?

@bsubercaseaux
Copy link
Owner

mmmh, I think:

  1. Inline (as you did) seems to look better)
  2. one option is to add a footnote saying that's how Lean comments look like
  3. another option is to remove the comments altogether.

Either is fine with me!

@digama0
Copy link
Collaborator

digama0 commented Jun 8, 2024

I think it's best to keep the comments, since it may not be obvious that cw is referring to clockwise, and also its relationship to positivity is important for things like ofReal. You could also make them doc-comments and beef them up to proper sentences or at least sentence fragments though.

@JamesGallicchio
Copy link
Collaborator Author

I think for the paper the positivity element is not so important, but I left intuitive comments for explanation.

I added doc comments to the actual codebase since that seems like a good idea.

@JamesGallicchio JamesGallicchio merged commit 4983f58 into main Jun 10, 2024
2 checks passed
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.

3 participants