-
Notifications
You must be signed in to change notification settings - Fork 26
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
Reorganize the code base #904
Conversation
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.
Thank you, I think the new structure is much nicer than what we had before. _glm.py
in particular was rather unwieldy. I just have a few small comments, plus the following bigger ones.
Functions that are imported by another file have been renamed so they don't start with a leading underscore.
Where does that convention come from? I though we mostly use underscores to denote functions which are private for the users of glum. I understand that these functions live in underscored modules, which can mean the same thing, but why switch? I personally don't see a huge benefit in using names to denote whether functions are module-private or package-private. When working on glum, it's simple to use 'Go to referencesand
Rename symbol` to make changes across files anyways.
This is not to say that I'm totally opposed to the proposed change. If the consensus is to follow the new convention, that's fine with me.
This PR breaks some files into smaller ones. It doesn't introduce any substantive changes.
This is my more important point: we should still check downstream projects before merging this to make sure we don't break to much stuff the this refactor (or at least give them some time for them to prepare for it). I know that you are not changing the public API, but it would not surprise me if downstream users were relying on some private functions, too.
At the moment, there's no pattern to which functions take a leading underscore. Some private functions don't have one (e.g.,
It would, but I'm trying to minimise downstream breakage. |
In that case I'm fine with either, and agree that we should pick one and be consistent. |
Could this solve the doctest issue? Edit: ah, nevermind, I see you handled it already. |
It didn't. |
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.
LGTM but I imagine @jtilly and @MarcAntoineSchmidtQC have more to say
This PR breaks some files into smaller ones. It doesn't introduce any substantive changes.
Functions that are imported by another file have been renamed so they don't start with a leading underscore.