gethelpvar

gethelpvar(filename, variables=None)

Return variable descriptions and names from an M-file help header.

Descriptions and names are 1-by-N rows, the same shape as EEGLAB’s cell outputs. With no variables argument, every documented description is returned. Otherwise descriptions follow the requested order, and names still list every documented variable. An unknown name has an empty description.

Parameters:

• filename (str | Path) – MATLAB source file whose leading help comments are parsed.

• variables (str | Sequence[str] | None) – Optional name or ordered names whose descriptions should be returned.

Return type:

tuple[ndarray, ndarray]