helpforexe#

helpforexe(functions, folder)#

Write one help script per function into folder.

Each name may end in .m. The help text is that EEGPrep function’s docstring, which is the text EEGLAB would take from the leading % block of the .m file. The output file is named help_<name> and contains one disp statement per docstring line.

The generated scripts are not executed. EEGLAB changes directory and evaluates them to confirm they parse as MATLAB; that check belongs to the compiled MATLAB application.

Parameters:

  • functions (str | Sequence[Any] | ndarray) – A function name, or several names in a list or cell array.

  • folder (str | Path) – Directory that receives the help scripts. It must already exist.

Raises:

FileNotFoundError – A name is not an EEGPrep function.

Return type:

None

On this page