-
Notifications
You must be signed in to change notification settings - Fork 13
Doc #1075 docu update #1114
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
Doc #1075 docu update #1114
Conversation
8037425 to
5434c49
Compare
All solved in 5434c49 |
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.
-
HENK : 4161489 7607878 . Not clear where the deleted code went to
JAN: This went to CustomsScripts - ExploreASLLegacy and StudyConfigFiles. As agreed previously. -
HENK: Also,
README.mdwill conflict with other changes that I recently did on the CFF (that you merged already I believe)
JAN: I know about these. That's why I push to do this ASAP. -
HENK: 94e2b4c Can you please next time add the filename in the commit ;)
JAN: Yes, sure. Though note that this goes against the good practice of keeping it short under 50 chars. Because then it's cutted when displayed in this GUI.
HENK: Good point, but still I think we're faster when having the overview with the filename first in the commit title :) What would you prefer? -
HENK: 57349ae Are you sure the contributors should go to another file, and everyone can then still easily find it? This contributors thingy is updated automatically with a separate plugin.
JAN: I moved these to Docu, to avoid having them on two places. But if this is updated automatically, then I can leave a copy here and also in Docu. Up to you.
HENK: I think this should stay in README.md indeed, as this is crawled automatically by third-party tools/others. -
HENK: baa0243 I would remove the whole templates folder, move these source and study templates to the docu online, and add a link to them when starting the import (like we did with datapar for processing).
JAN: Done as discussed. 93e0092 -
HENK: 1a99be5 Are you sure development should be a subfolder of Functions? That means that they will be added to the path by default. I thought the whole idea of having the development separately from the functions folder, was not to have them automatically added to the Matlab path.
JAN: We still have theExploreASL/Developmentfolder there that contains things that are still being developed. And you are right about this one. But I haven't changed that one. This folderExploreASL/Functions/Developmentcontain functions that are mature enough to be included in the real code, but are seldom used by the user but rather by the core development team. These are things like compilation, docu deployment etc. We've discussed this previously and the consensus was to create this new subfolder and prefix dev to separate these from the often used adm functions. So I would keep as it as following our previous decision ;)
HENK: OK but that would be confusing, as the code is not in development (who uses what code is not the reason for the categorization). Cannot remember this decision :( Do you think the user actually looks into these folders? I would vote for a folder with docu and a folder with deploy rather than putting all the functions in a general dev folder. Otherwise, it defies the purpose of having a clear prefix (soon many stuff can have the prefix dev; same for adm. Best to keep more categories?).
JAN: Consensus Functions/Development stays. ExploreASL/Development is renamed to WorkInProgress. -
https://exploreasl.github.io/Documentation/latest/ProcessingParametersis not compiled properly:
ccb4103 to
c59af0f
Compare
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.
You can put the ExploreASL team back to the docu, only the contributors part is crawled.
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.
Why don't we add genpath(fullfile(x.opts.MyPath, 'Functions')) ?That's much shorter than that long list of folders
1) Added hyperlink, added \n and moved to ExploreASL_Import, will run now also if there is an import error
1) Added hyperlink, added \n and moved to ExploreASL_init_DataLoading, will run now also if there is a processing error
984dc04 to
ddbb7f8
Compare

Linked issue
Close #1075