You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
DOC: Fix parameter names in private helper docstrings
Ten docstrings name a parameter that is not in the signature, so
help() and editor tooltips show an argument that raises TypeError.
Renames, one to one:
- _lin_field_coeff and _do_lin_field_coeff: rmag/cosmag -> rmags/cosmags.
The line just below already says 'for each rmag/cosmag/w', so the
singular there is the element, the parameter is the plural.
- write_named_matrix: matkind -> mat. mat was undocumented.
- text2d: x/y -> x_window/y_window.
- _cart_to_sph: cart_pts -> cart.
- _sss_basis: coils -> all_coils.
And one wrong default: _ajd_pham documents max_iter=1000, the signature
has 15. pyRiemann, which the comment credits as the source, uses 20.
Docstrings only.
Fix ten docstrings in private helpers that named a parameter the function does not take, and one that documented ``max_iter=1000`` for :func:`mne.decoding.csp._ajd_pham` while the signature has ``15``, by `Anton Karpov`_.
0 commit comments