-
Notifications
You must be signed in to change notification settings - Fork 13
Closes #1040 Revamp #1041
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
Closes #1040 Revamp #1041
Conversation
HenkMutsaerts
left a comment
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.
everything looks nice, but I wonder if the separation of the functions in separate folders is helpful, we should probably discuss this first. Moving development to the Function folder is not helpful, the Function folder contains functions that are used (and initialized), the development folder should not be initialized. I would vote against initializing each function folder separately. I like the new README a lot!
|
jan-petr
left a comment
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.
I'm fine with everything - except those things Henk said. See my answer to that in PR.
|
OK so:
|
|
I personally find it quite hard to navigate with all functions in the same directory. Especially for newer or unexperienced developers it's harder to keep the overview. It's also helpful to have more structure so that we can easily document like with the shown readme. In SubModules ASL there are only wrappers. In the population module there are a few stat, im and other functions. Maybe that's rather a thing that could be cleaned up, too. Like I said in the issue, I just thought it could make sense to rethink some things to make it easier for people to work with and on xasl. So those are the main reasons why I would move the functions to sub-directories and generally revamp the structure. I don't care that much about the location of Development. We can move it back if you want. I was just trying to hide it a bit, because IMHO it's not common to have unfinished/untested functions in released software. That's one of the main reasons why I think we don't need it at all. If you download any other framework you wouldn't expect to find unfinished not fully working code. |
As said. No strong opinion on that. But I agree that this is might be confusing for some people, so I'm fine with subdirectories.
ASL and Structural modules are a great example where wrappers are in modules and functions in functions. And I agree that for Import and Population, this is somehow messy. Import would definitively need a revamp in names as some imp files should be wrp but we should make a separate issue for that and agree on what to do exactly before we do that ;) Same for population.
Good point. But I am not sure if hiding it makes it any better :) Still, it is not just some unfinished code. It is a code that should be used with caution and code that we actually do use for some specific studies. But not so specific that we could move it to CustomScripts. So I would move it back to root (no need to revert, we just move again) and update the init-path. And we make a new issue where we discuss some further changes. For example (but lets write those to the new issue and find a consensus first):
@HenkMutsaerts What do you think? |
Nice work! |
8fcd13e to
bfc04d0
Compare
Linked issue
Check out #1040.
Comments
@HenkMutsaerts & @jan-petr: I'd recommend to prioritize this PR, since it's another revamp one (would help to keep the amount of conflicts smaller)⚠️
Testing
Documentation testing ✔️
Initialization testing ✔️
Essential unit tests ✔️