From b97e579b0f47ca8de34567ccb4c516568d11bbb5 Mon Sep 17 00:00:00 2001 From: Daniel McCloy Date: Fri, 2 Feb 2024 13:37:22 -0600 Subject: [PATCH] disable (mostly broken) "edit on GitHub" link in sidebar (#12412) Co-authored-by: Eric Larson --- doc/conf.py | 2 +- mne/epochs.py | 2 +- mne/utils/docs.py | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 40222a265fe..7773be834fd 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -839,7 +839,7 @@ def append_attr_meth_examples(app, what, name, obj, options, lines): ), ], "icon_links_label": "External Links", # for screen reader - "use_edit_page_button": True, + "use_edit_page_button": False, "navigation_with_keys": False, "show_toc_level": 1, "article_header_start": [], # disable breadcrumbs diff --git a/mne/epochs.py b/mne/epochs.py index 1e86c6c96b0..952f0b27d96 100644 --- a/mne/epochs.py +++ b/mne/epochs.py @@ -1408,7 +1408,7 @@ def drop_bad(self, reject="existing", flat="existing", verbose=None): Dropping bad epochs can be done multiple times with different ``reject`` and ``flat`` parameters. However, once an epoch is dropped, it is dropped forever, so if more lenient thresholds may - subsequently be applied, `epochs.copy ` should be + subsequently be applied, :meth:`epochs.copy ` should be used. """ if reject == "existing": diff --git a/mne/utils/docs.py b/mne/utils/docs.py index 87f457a982b..17575f3a124 100644 --- a/mne/utils/docs.py +++ b/mne/utils/docs.py @@ -3366,6 +3366,7 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75): .. note:: If ``reject`` is a callable, than **any** criteria can be used to reject epochs (including maxima and minima). + If ``reject`` is ``None``, no rejection is performed. If ``'existing'`` (default), then the rejection parameters set at instantiation are used. """ # noqa: E501