Skip to content
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

Sort Format #778

Merged
merged 9 commits into from
Sep 9, 2024
Merged

Sort Format #778

merged 9 commits into from
Sep 9, 2024

Conversation

teddychao
Copy link
Contributor

@teddychao teddychao commented Sep 9, 2024

Summary

This PR sort the Format section in help text. Now pspm_doc can read the help text and sort them by adding or between multiple possible formats.

Details of updates

  • pspm
    • The help text was updated to be in line with general PsPM help text style.
  • src/pspm_bf_FIR.m
    • The or in Format was removed.
  • src/pspm_bf_hprf_e.m, src/pspm_filtfilt.m, src/pspm_pp.m, src/pspm_transfer_function.m
    • The or in Format was removed and the formats were sorted into two lines, and or was removed.
  • src/pspm_bf_hprf_rew.m
    • Converted to LF (Unix).
  • src/pspm_cfg/pspm_cfg_emg_pp.m, src/pspm_cfg/pspm_cfg_find_valid_fixations.m, src/pspm_cfg/pspm_cfg_glm_sps.m, src/pspm_cfg/pspm_cfg_process_illuminance.m, src/pspm_cfg/pspm_cfg_pupil_preprocess.m, src/pspm_cfg/pspm_cfg_run_emg_pp.m, src/pspm_get_hp.m
    • Change help text to be in line with general PsPM help text style.
  • src/pspm_convert_au2unit.m
    • General PsPM help text style does not allow a "Features" section, so it has been merged into "Description".
  • src/pspm_display.m, src/pspm_doc.m, src/pspm_get_timing.m, src/pspm_jobman.m
    • Updated to display sessions in "Format"
  • src/pspm_get_cnt.m, src/pspm_time2index.m
    • "Format" does not allow plain text as description, so such plain text has been moved to "Developer's notes"
  • src/pspm_load_channel.m
    • One format uses one line even if it is very long, otherwise it will be recognised as two formats.

Issues

In pspm_get_hp, the arguments section says there is an input variable data, but it does not exist in the function format.

@teddychao teddychao marked this pull request as ready for review September 9, 2024 20:32
@teddychao teddychao self-assigned this Sep 9, 2024
@teddychao teddychao added the Completed & Waiting for Review Completed and waiting for review label Sep 9, 2024
@teddychao teddychao added this to the v7.0 milestone Sep 9, 2024
@dominikbach dominikbach merged commit d7f2549 into develop Sep 9, 2024
1 check passed
@dominikbach dominikbach deleted the Sort-Format branch September 9, 2024 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Completed & Waiting for Review Completed and waiting for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants