mne-python icon indicating copy to clipboard operation
mne-python copied to clipboard

document how to change docstrings when deprecating params

Open drammock opened this issue 7 months ago • 0 comments

Proposed documentation enhancement

we should update https://mne.tools/dev/development/contributing.html#deprecate-with-a-decorator-or-a-warning to have a docstring in the example function, that shows how to use our sphinx roles etc within the param descriptions.

drammock avatar Dec 06 '23 15:12 drammock