Back to the main page.
Bug 1077 - implement a general documentation structure for guidelines
| Status | CLOSED DUPLICATE |
| Reported | 2011-10-26 15:23:00 +0200 |
| Modified | 2018-03-10 22:02:21 +0100 |
| Product: | FieldTrip |
| Component: | documentation |
| Version: | unspecified |
| Hardware: | PC |
| Operating System: | Mac OS |
| Importance: | P1 normal |
| Assigned to: | Lilla Magyari |
| URL: | |
| Tags: | |
| Depends on: | |
| Blocks: | |
| See also: |
Robert Oostenveld - 2011-10-26 15:23:41 +0200
ft_preprocessing has an old guidelines section, see also private/guidelines TODO: - implement guidelines for three (arbitrary functions) in the main help - ensure that hyperlinking on the wiki/references works - discuss the aesthetics in the FT meeting
Robert Oostenveld - 2011-10-26 15:37:56 +0200
I just implemented the general handling of if nargin==0 help(mfilename) error(...) end
Robert Oostenveld - 2011-11-02 09:01:33 +0100
I removed the following section from ft_preprocessing if nargin==0 help(mfilename); return elseif nargin==1 && isequal(cfg, 'help') help(mfilename); return elseif nargin==1 && isequal(cfg, 'guidelines') guidelines(mfilename); return end The guidelines %-help is still there
Saskia Haegens - 2012-02-01 15:03:16 +0100
implemented for: ft_preprocessing ft_freqanalysis ft_timelockanalysis
Jan-Mathijs Schoffelen - 2012-09-19 14:40:32 +0200
discussion in FT-meeting 19-09-2012: Also make the documentation of the function as such consistent. e.g. Use as [output] = ft_xxxxxx(cfg, input) [output] = ft_xxxxxx(cfg, input1, input2) where input is named according to the fieldtrip datatype that is going into the function, and output as well.
Robert Oostenveld - 2012-09-19 17:28:37 +0200
I have added something here http://fieldtrip.fcdonders.nl/code_guidelines#provide_reference_documentation_in_the_function_help and made some changes in Sending ft_datatype.m Transmitting file data . Committed revision 6480.