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

Make variables names _∙∙_∙∙_ consistent with those in doubleComp-faces and remove an unnecessary space #1029

Merged
merged 1 commit into from
Sep 4, 2023

Conversation

ShreckYe
Copy link
Contributor

@ShreckYe ShreckYe commented Aug 4, 2023

Hi Maintainers, I am new to Cubical Agda. The variable name order of "x", "y", "z", and "w" is different in the functions _∙∙_∙∙_ and doubleComp-faces which the former depends on, thus "p" and "r" in 2 functions have different types in reading. This confuses beginners like me when I learn their implementations for the first time.
I also notice that throughout the library the order of such plain letter variables is different in different functions. Maybe a rule/guideline of a canonical order can be enforced to reduce these confusions. Or ignore me if it's just a trivial beginner problem.

@MatthiasHu
Copy link
Contributor

Thanks! Merging.

@MatthiasHu MatthiasHu merged commit d643547 into agda:master Sep 4, 2023
1 check passed
@MatthiasHu
Copy link
Contributor

I also notice that throughout the library the order of such plain letter variables is different in different functions. Maybe a rule/guideline of a canonical order can be enforced to reduce these confusions.

There is indeed a lot of inconsistency (in style, naming, ...) in the library. I personally can't imagine a reasonable guideline to decide between "x y z w" and "w x y z". But if you find something that confuses or annoys you and you can fix it quickly, then I do think it is nice to make a PR out of it.

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