Unify help #735
Merged
Unify help #735
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 7 commits
June 19, 2024 19:09
This reverts commit 90b6676.
dominikbach
added
Completed & Waiting for Review
teddychao
added
Under Review
and removed
Completed & Waiting for Review
I suggest that I can update |
teddychao
reviewed
Aug 11, 2024
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.
startindx and endindx could be 1xn (n>1) array. I would suggest to use transpose in this occasion. Please find screenshot.
teddychao
reviewed
Aug 11, 2024
|
|
||
| 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.
Just now sure if this is expected...
teddychao
reviewed
Aug 11, 2024
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.
There are two duplicated lines?
teddychao
reviewed
Aug 11, 2024
| % ├───────.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.
There is an empty line above History section. Better to delete it to avoid potential mis-recognition.
teddychao
approved these changes
Aug 11, 2024
teddychao
added
Approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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_reviewwhich has no function helppspm_process_illuminance: function help needs to be modified forpspm_helppspm_pupil_correct: function help needs to be modified forpspm_help