evoked.plot_joint API exclude
parameter docstring is inconsistent with the code
#13157
Labels
exclude
parameter docstring is inconsistent with the code
#13157
Description of the problem
The API doc Shows that the default value for parameter
exclude
is'bads'
, but in the description for that parameter, it says that the default isNone
, when In fact,None
is not even a valid argument for this parameter:Steps to reproduce
Expected results
Figure shows with no bad channels excluded.
Actual results
ValueError: include/exclude must be list, tuple, ndarray, or "bads". You provided type <class 'NoneType'>.
Additional information
Should the code be fixed to match the docstring (i.e. accept
None
, and make it the default), or should the mention ofNone
simply by removed from the docstring?The text was updated successfully, but these errors were encountered: