Back to the main page.
Bug 2351 - document the print/warning/error usage in the code guidelines
| Status | CLOSED FIXED |
| Reported | 2013-10-31 10:35:00 +0100 |
| Modified | 2018-03-10 21:38:15 +0100 |
| Product: | FieldTrip |
| Component: | documentation |
| Version: | unspecified |
| Hardware: | PC |
| Operating System: | Mac OS |
| Importance: | P3 normal |
| Assigned to: | Lilla Magyari |
| URL: | http://fieldtrip.fcdonders.nl/development/meeting/20131030 |
| Tags: | |
| Depends on: | |
| Blocks: | |
| See also: |
Robert Oostenveld - 2013-10-31 10:35:17 +0100
as discussed in this Wednesday's meeting: --- There are 5 different ways of giving information to users about the running of a code: silent: It is not communicated what happens print: Notifications are printed on screen. E.g.: “processing trials” warning once: A warning printed on the screen when it occurs first. warning: A warning printed on screen. E.g.: “Warning: no baseline correction” error: Error printed on screen and the process is terminated. We agreed today about the following: we should use warning and error identifiers. We would also like to give more information about the warnings. As a general guideline, when a warning is implemented, there should also be a frequently asked question created which explains why the warning has been implemented. The warning identifiers could help the user to find the relevant FAQ. The FAQ should also have a 'warning' tag. By using identifiers, warnings can be switched off automatically in Matlab. Hence, 'warning once' will be not necessary. --- This should be added to http://fieldtrip.fcdonders.nl/development/guidelines/code e.g. under a subheading "Provide the appropriate level of feedback to the user"