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
Mention that some fields are currently lowercase, not following the current conventions #440
Conversation
templates/contribute/naming.md
Outdated
@@ -50,6 +50,10 @@ class HPow (α : Type u) (β : Type v) (γ : Type w) where | |||
class LT (α : Type u) where | |||
lt : α → α → Prop -- follows rule 4 and 6 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you intend to remove this example?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not really, as I have amended rule 6.
Co-authored-by: Yaël Dillies <yael.dillies@gmail.com>
@fpvandoorn It seems to me this PR got somewhat stuck... |
Could you split off the forking instructions to another PR and rename this one to something more evocative? |
Sure (although I am boarding a plane now and it won't be immediate). Can you just tell me if the forking instructions are OK or if they would at any rate be ignored "because they're so trivial" (something I often hear, but I would argue that a superfluous instruction makes no harm to those who know and can help those who don't)? |
Done (and opened #471 ) |
I think the issue here is that you're documenting exceptions as the rule. |
I see your point, and agree. Yet I find it a bit frustrating (and I'm not alone, in view of recent LFTCM experience) that the library is full of exceptions. Would you agree if I modify my text explicitly mentioning that there are exception to the rule(s), but that these will hopefully eventually disappear and users should adhere to the rules rather than trying to mimic what they find in the library? |
Yes, I'm happy if you state the existence of exceptions. Aside: I haven't noticed the "uncapitalize projection fields" as a big naming issue myself. All lemmas are still correctly named, since a declaration And btw, please add more "trivial" steps to our Git instructions on the website. They are very hard for mathematicians to follow! Please incorporate the instructions from the Git tutorial at LFTCM that I gave into the website! |
I have added the LT exception and will add more GIT instructions as they come to mind. One thing that I would like to discuss (but completely outside this PR) is the confusion between the Lean and the Math community in the website: it is called "Lean Community" but basically only speaks about Mathlib. For instance, the |
Co-authored-by: Floris van Doorn <fpvdoorn@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2 wrongly spaced things (I'll fix them myself), otherwise, this looks good to me.
Modify the instructions in the naming convention file about
LT
vslt
and add a new example.Add a sentence requiring to fork before creating a PR in the readme.md file