Back to the main page.
Bug 1376 - cfg options should obey to (updated) code guidelines
| Status | CLOSED FIXED |
| Reported | 2012-03-14 15:38:00 +0100 |
| Modified | 2015-07-15 13:31:08 +0200 |
| Product: | FieldTrip |
| Component: | core |
| Version: | unspecified |
| Hardware: | PC |
| Operating System: | Windows |
| Importance: | P3 enhancement |
| Assigned to: | Robert Oostenveld |
| URL: | |
| Tags: | |
| Depends on: | |
| Blocks: | |
| See also: |
Jörn M. Horschig - 2012-03-14 15:38:05 +0100
In a short meeting with Robert, we encountered several small things to be changed (all with low priority). A function should only use a cfg-option if the output will be different. E.g. freqdescriptives should not use cfg.channel, because data should be selected first (or afterwards) with ft_selectdata instead. This will reduce the number of possible cfg options, reduce overlap and give functions a better overview, consistency and efficiency. - code guidelines should be updated and mention this - functions should be updated and an appropriate warning should be given (e.g. use ft_checkconfig(cfg, 'deprecated', ...)
Jan-Mathijs Schoffelen - 2012-09-24 10:12:42 +0200
cleaning up the unassigned bug list ;-)
Robert Oostenveld - 2015-02-11 13:47:44 +0100
The example ft_freqdescriptives was mentioned. I see that internally it uses the old ft_selectdata. That is also something to fix. I don't see how this is to be further clarified in the documentation. There is http://fieldtrip.fcdonders.nl/development/guidelines/code#adding_new_configuration_options and further. freqdescriptives is being used in roboos@mentat003> grep -l ft_freqdescriptives test/*.m test/test_bug1041.m test/test_bug1677.m test/test_bug2148.m test/test_bug905.m test/test_example_combineplanar_pipelineorder.m test/test_old_connectivityanalysis.m test/test_tutorial_clusterpermutationfreq.m test/test_tutorial_connectivity20130308.m test/test_tutorial_connectivity2.m
Robert Oostenveld - 2015-02-11 16:10:53 +0100
roboos@mentat003> svn commit ft_freqdescriptives.m Sending ft_freqdescriptives.m Transmitting file data . Committed revision 10205. this fixes ft_freqdescriptives. I dno't think there are other explicit things to be done here.