Skip to content

Commit 3f70019

Browse files
committed
FIX: Fix docstring
1 parent 4d401d0 commit 3f70019

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

mne/datasets/kiloword/kiloword.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,6 @@ def data_path(path=None, force_update=False, update_path=True, download=True,
4747
download=download)
4848

4949

50-
data_path.__doc__ = _data_path_doc.format(
51-
name='kiloword', conf='MNE_DATASETS_KILOWORD_PATH')
52-
53-
5450
def get_version():
5551
"""Get dataset version."""
5652
return _get_version('kiloword')

mne/datasets/utils.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,7 @@ def _data_path(path=None, force_update=False, update_path=True, download=True,
270270
# filename of the resulting downloaded archive (only needed if the URL
271271
# name does not match resulting filename)
272272
archive_names = dict(
273+
kiloword='MNE-kiloword-data.tar.gz',
273274
misc='mne-misc-data-%s.tar.gz' % releases['misc'],
274275
multimodal='MNE-multimodal-data.tar.gz',
275276
sample='MNE-sample-data-processed.tar.gz',

mne/epochs.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,10 @@ class BaseEpochs(ProjMixin, ContainsMixin, UpdateChannelsMixin,
211211
ignored.
212212
filename : str | None
213213
The filename (if the epochs are read from disk).
214-
metadata : DataFrame | None.
215-
See `Epochs` docstring.
214+
metadata : instance of pandas.DataFrame | None
215+
See :class:`mne.Epochs` docstring.
216+
217+
.. versionadded:: 0.16
216218
verbose : bool, str, int, or None
217219
If not None, override default verbose level (see :func:`mne.verbose`
218220
and :ref:`Logging documentation <tut_logging>` for more). Defaults to
@@ -1867,7 +1869,7 @@ class Epochs(BaseEpochs):
18671869
Whether to reject based on annotations. If True (default), epochs
18681870
overlapping with segments whose description begins with ``'bad'`` are
18691871
rejected. If False, no rejection based on annotations is performed.
1870-
metadata : None | instance of pandas.DataFrame
1872+
metadata : instance of pandas.DataFrame | None
18711873
A :class:`pandas.DataFrame` specifying more complex metadata about
18721874
events. If given, ``len(metadata)`` must equal ``len(events)``.
18731875
The DataFrame may have values of type (str | int | float).
@@ -2042,7 +2044,7 @@ class EpochsArray(BaseEpochs):
20422044
Apply SSP projection vectors. See :class:`mne.Epochs` for details.
20432045
on_missing : str
20442046
See :class:`mne.Epochs` docstring for details.
2045-
metadata : None | instance of pandas.DataFrame
2047+
metadata : instance of pandas.DataFrame | None
20462048
See :class:`mne.Epochs` docstring for details.
20472049
20482050
.. versionadded:: 0.16

0 commit comments

Comments
 (0)