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

Find all single letter publicly-exported modules and make sure they are private #2472

Open
MatthewDaggitt opened this issue Sep 3, 2024 · 5 comments
Milestone

Comments

@MatthewDaggitt
Copy link
Contributor

Currently we have many single letter modules that are unintentionally being exported publicly by other modules. In v3.0 we should do a sweep and make them all private (or rename them to something more meaningful if we really do want to export them!).

@MatthewDaggitt
Copy link
Contributor Author

MatthewDaggitt commented Sep 3, 2024

See #2407 (comment) for an example

@jamesmckinna
Copy link
Contributor

Ha!/Oops! 🤦‍♂️

The final merged version of #2407 in fact does make R a private module definition now... so we have just merged a breaking change... sorry about that! ...
... but hopefully a harmless one (given that the Algebra.Solver.* machinery appears to have been superseded by Tactic.*Solver, but without being deprecated... so perhaps there are clients uses out there, hopefully they don't explicitly refer to R!?)

If anyone reports breaking behaviour, I'll post a follow-up PR, but perhaps better to let sleeping dogs lie? Let me know!

@jamesmckinna
Copy link
Contributor

A quick pass via grep suggests that the Solver export might have been the only such instance? Additional eyes welcome on this...

@MatthewDaggitt
Copy link
Contributor Author

A quick pass via grep suggests that the Solver export might have been the only such instance? Additional eyes welcome on this...

That is a little surprising. I definitely remember having seen the pattern used in Data.List.Relation hierarchy, but given that this is a v3.0 change, I'm not going to spend too long digging now. We should just bear it in mind when writing new code for the moment.

@jamesmckinna
Copy link
Contributor

No need to dig now, but we could make a task list here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants