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

Files should not import Everything files unless necessary #570

Closed
mortberg opened this issue Jun 9, 2021 · 6 comments · Fixed by #789
Closed

Files should not import Everything files unless necessary #570

mortberg opened this issue Jun 9, 2021 · 6 comments · Fixed by #789

Comments

@mortberg
Copy link
Collaborator

mortberg commented Jun 9, 2021

Some files import Everything files for no reason which can cause a headache when refactoring or renaming. It would be good to remove unnecessary imports of Everything and instead have more fine grained imports (for example if a file only uses 2-3 modules from Foundations there is no reason to import Foundations.Everything)

@mortberg
Copy link
Collaborator Author

mortberg commented Jun 9, 2021

This should also be added to the styleguide

@L-TChen
Copy link
Member

L-TChen commented Jul 20, 2021

Maybe off-topic, but I wonder why Cubical.Foundations.Everything renames a number of functions which are not reexported at all. What is the intended purpose of Everything after all?

@anuyts
Copy link
Contributor

anuyts commented Mar 21, 2022

Currently, when I checkout the master branch and try to type-check Cubical.README, it fails because Cubical.Functions.Everything is missing. I see that there is a script Everythings.hs for generating them, but there is no guide about what I'm supposed to do at this point.

@felixwellen
Copy link
Collaborator

You can run make. I think this was mentioned as an installation step in the past, but got removed. So this is only mentioned in CONTRIBUTING.md now. I guess the idea is, that you only want to check the whole library as a contributer, but not as a user.

@anuyts
Copy link
Contributor

anuyts commented Mar 21, 2022

Well, an end-user would expect to be able to typecheck a file called README.agda :-)

@felixwellen
Copy link
Collaborator

I agree, that is a reasonable expectation ;-)
There is a trade-off: make requires runhaskell, which is not available on any system that runs agda. So some people ran into problems, when they tried to run make. I guess the ideal solution would be to make that problem go away, so everyone can just run README.agda, after setting everything up.

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 a pull request may close this issue.

4 participants