-
Notifications
You must be signed in to change notification settings - Fork 11
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
Unify help #735
Unify help #735
Conversation
This reverts commit 90b6676.
src/pspm_cfg/pspm_cfg_help_format.m
Outdated
% this syntax allows chaining several nested structs into one argname | ||
evalc(sprintf('helptext = settings.help.%s.Arguments.%s;', funcname, argname)); | ||
[startindx, endindx] = regexp(helptext, '\[\s*([^\[\]]*)\s*\]'); % thanks ChatGPT for finding the regexp | ||
helptext(startindx:endindx) = []; |
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.
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.
fixed.
|
||
ecg2hb_amri_teo_bandpass = cfg_entry; | ||
ecg2hb_amri_teo_bandpass.name = 'TEO bandpass filter'; | ||
ecg2hb_amri_teo_bandpass.tag = 'teo_bandpass'; | ||
ecg2hb_amri_teo_bandpass.strtype = 'r'; | ||
ecg2hb_amri_teo_bandpass.num = [1 2]; | ||
ecg2hb_amri_teo_bandpass.val = {[8 40]}; | ||
ecg2hb_amri_teo_bandpass.help = {['Define the cutoff frequencies (Hz) for bandpass filter applied to filtered ECG',... | ||
' signal before applying TEO']}; | ||
ecg2hb_amri_teo_bandpass.help = pspm_cfg_help_format('pspm_convert_ecg2hb_amri', 'options.teo_bandpass'); |
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.
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.
fixed.
src/pspm_combine_markerchannels.m
Outdated
@@ -18,6 +18,7 @@ | |||
% │ the first option is used, then use marker channel | |||
% │ indexing in further processing which by default | |||
% │ takes the first marker channel as input | |||
% └.marker_chan_num: any number of marker channel numbers - if undefined | |||
% └.marker_chan_num : any number of marker channel numbers - if undefined |
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.
There are two duplicated lines?
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.
fixed.
% ├───────.channel: [numeric/string] Channel to be preprocessed. | ||
% │ Can be a channel ID or a channel name. | ||
% │ Default is 'emg' (i.e. last EMG channel) | ||
% └.channel_action: ['add'/'replace'] Defines whether the new channel should | ||
% be added or the previous outputs of this function should | ||
% be replaced. (Default: 'replace') |
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.
There is an empty line above History
section. Better to delete it to avoid potential mis-recognition.
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.
fixed.
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.
Tested all the functions that use pspm_cfg_help_format
and found them running ok.
Just minor changes could be useful....
Fixes #23 .
Changes proposed in this pull request: Matlabbatch GUI items follow the logic of using function help wherever possible.
Exceptions:
pspm_cfg_selector_...
functionspspm_import
, which is partly summarised inpspm_text
. This will be dealt with in a separate PR.pspm_review
which has no function helppspm_process_illuminance
: function help needs to be modified forpspm_help
pspm_pupil_correct
: function help needs to be modified forpspm_help