diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index 3940a79158b..c30ac7e3acf 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -10,6 +10,6 @@ assignees: '' For example: "add 'foo' to the glossary" or "add my favorite visualization to the ERP tutorial".* -#### Proposed documentation ehancement +#### Proposed documentation enhancement *Describe your proposed enhancement in detail. If you are requesting a new glossary term, please include a proposed definition.* diff --git a/Makefile b/Makefile index 6ed39391e75..7a68b9d2806 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -# simple makefile to simplify repetetive build env management tasks under posix +# simple makefile to simplify repetitive build env management tasks under posix PYTHON ?= python PYTESTS ?= py.test diff --git a/mne/beamformer/tests/test_dics.py b/mne/beamformer/tests/test_dics.py index 1e5f8db975e..9f9ed919899 100644 --- a/mne/beamformer/tests/test_dics.py +++ b/mne/beamformer/tests/test_dics.py @@ -429,7 +429,7 @@ def test_real(_load_forward, idx): reg = 1 # Lots of regularization for our toy dataset filters_real = make_dics(epochs.info, fwd_surf, csd, label=label, reg=reg, real_filter=True, inversion='single') - # Also test here that no warings are thrown - implemented to check whether + # Also test here that no warnings are thrown - implemented to check whether # src should not be None warning occurs: power, f = apply_dics_csd(csd, filters_real) diff --git a/mne/bem.py b/mne/bem.py index 0d601afb3b6..1ca83e70b63 100644 --- a/mne/bem.py +++ b/mne/bem.py @@ -1136,7 +1136,7 @@ def make_watershed_bem(subject, subjects_dir=None, overwrite=False, if op.isfile(T1_mgz): new_info = _extract_volume_info(T1_mgz) if has_nibabel() else dict() if not new_info: - warn('nibabel is not available or the volumn info is invalid.' + warn('nibabel is not available or the volume info is invalid.' 'Volume info not updated in the written surface.') surfs = ['brain', 'inner_skull', 'outer_skull', 'outer_skin'] for s in surfs: @@ -1718,7 +1718,7 @@ def _write_echos(mri_dir, flash_echos, angle): @verbose def convert_flash_mris(subject, flash30=True, unwarp=False, subjects_dir=None, flash5=True, verbose=None): - """Synthetize the flash 5 files for use with make_flash_bem. + """Synthesize the flash 5 files for use with make_flash_bem. This function aims to produce a synthesized flash 5 MRI from multiecho flash (MEF) MRI data. This function can use MEF data diff --git a/mne/coreg.py b/mne/coreg.py index cbdec77dcc4..4187b754495 100644 --- a/mne/coreg.py +++ b/mne/coreg.py @@ -822,7 +822,7 @@ def _scale_params(subject_to, subject_from, scale, subjects_dir): scale = cfg['scale'] scale = np.atleast_1d(scale) if scale.ndim != 1 or scale.shape[0] not in (1, 3): - raise ValueError("Invalid shape for scale parameer. Need scalar " + raise ValueError("Invalid shape for scale parameter. Need scalar " "or array of length 3. Got shape %s." % (scale.shape,)) n_params = len(scale) diff --git a/mne/data/FreeSurferColorLUT.txt b/mne/data/FreeSurferColorLUT.txt index 2b85ef3f02b..ca285e937b8 100644 --- a/mne/data/FreeSurferColorLUT.txt +++ b/mne/data/FreeSurferColorLUT.txt @@ -173,7 +173,7 @@ 169 Left-Basal-Ganglia 236 13 127 0 176 Right-Basal-Ganglia 236 13 126 0 -# Label names and colors for Brainstem consituents +# Label names and colors for Brainstem constituents # No. Label Name: R G B A 170 brainstem 119 159 176 0 171 DCG 119 0 176 0 @@ -416,14 +416,14 @@ # created by mri_aparc2aseg in which the aseg cortex label is replaced # by the labels in the aparc. It also supports wm labels that will # eventually be created by mri_aparc2aseg. Otherwise, the aseg labels -# do not change from above. The cortical lables are the same as in +# do not change from above. The cortical labels are the same as in # colortable_desikan_killiany.txt, except that left hemisphere has # 1000 added to the index and the right has 2000 added. The label # names are also prepended with ctx-lh or ctx-rh. The white matter # labels are the same as in colortable_desikan_killiany.txt, except # that left hemisphere has 3000 added to the index and the right has # 4000 added. The label names are also prepended with wm-lh or wm-rh. -# Centrum semiovale is also labled with 5001 (left) and 5002 (right). +# Centrum semiovale is also labeled with 5001 (left) and 5002 (right). # Even further below are the color tables for aparc.a2005s and aparc.a2009s. #No. Label Name: R G B A diff --git a/mne/filter.py b/mne/filter.py index 9e481da55a2..16b387e4886 100644 --- a/mne/filter.py +++ b/mne/filter.py @@ -802,7 +802,7 @@ def filter_data(data, sfreq, l_freq, h_freq, picks=None, filter_length='auto', .. note:: If n_jobs > 1, more memory is required as ``len(picks) * n_times`` additional time points need to - be temporaily stored in memory. + be temporarily stored in memory. For more information, see the tutorials :ref:`disc-filtering` and :ref:`tut-filter-resample` and @@ -1993,7 +1993,7 @@ def filter(self, l_freq, h_freq, picks=None, filter_length='auto', .. note:: If n_jobs > 1, more memory is required as ``len(picks) * n_times`` additional time points need to - be temporaily stored in memory. + be temporarily stored in memory. For more information, see the tutorials :ref:`disc-filtering` and :ref:`tut-filter-resample` and @@ -2139,7 +2139,7 @@ def apply_hilbert(self, picks=None, envelope=False, n_jobs=None, If envelope=False, more memory is required since the original raw data as well as the analytic signal have temporarily to be stored in memory. If n_jobs > 1, more memory is required as ``len(picks) * n_times`` - additional time points need to be temporaily stored in memory. + additional time points need to be temporarily stored in memory. Also note that the ``n_fft`` parameter will allow you to pad the signal with zeros before performing the Hilbert transform. This padding diff --git a/mne/forward/forward.py b/mne/forward/forward.py index 0e931b1ddc7..e873b6a06ff 100644 --- a/mne/forward/forward.py +++ b/mne/forward/forward.py @@ -1321,7 +1321,7 @@ def compute_depth_prior(forward, info, exp=0.8, limit=10.0, ws = np.sort(w) weight_limit = limit ** 2 if limit_depth_chs is False: - # match old mne-python behavor + # match old mne-python behavior # we used to do ind = np.argmin(ws), but this is 0 by sort above n_limit = 0 limit = ws[0] * weight_limit diff --git a/mne/io/base.py b/mne/io/base.py index c4e885764e5..a216aa8a9a2 100644 --- a/mne/io/base.py +++ b/mne/io/base.py @@ -1043,7 +1043,7 @@ def notch_filter(self, freqs, picks=None, filter_length='auto', .. note:: If n_jobs > 1, more memory is required as ``len(picks) * n_times`` additional time points need to - be temporaily stored in memory. + be temporarily stored in memory. For details, see :func:`mne.filter.notch_filter`. """ diff --git a/mne/io/eeglab/tests/test_eeglab.py b/mne/io/eeglab/tests/test_eeglab.py index 598d90879b9..2dd074a7222 100644 --- a/mne/io/eeglab/tests/test_eeglab.py +++ b/mne/io/eeglab/tests/test_eeglab.py @@ -317,7 +317,7 @@ def test_degenerate(tmp_path): @pytest.mark.parametrize("fname", [ raw_fname_mat, raw_fname_onefile_mat, - # We don't test the h5 varaints here because they are implicitly tested + # We don't test the h5 variants here because they are implicitly tested # in test_io_set_raw ]) @pytest.mark.filterwarnings('ignore: Complex objects') diff --git a/mne/io/snirf/_snirf.py b/mne/io/snirf/_snirf.py index 134497c679f..f3487f0fd3b 100644 --- a/mne/io/snirf/_snirf.py +++ b/mne/io/snirf/_snirf.py @@ -96,8 +96,8 @@ def __init__(self, fname, optode_frame="unknown", "MNE does not support this feature. " "Only the first dataset will be processed.") - manafacturer = _get_metadata_str(dat, "ManufacturerName") - if (optode_frame == "unknown") & (manafacturer == "Gowerlabs"): + manufacturer = _get_metadata_str(dat, "ManufacturerName") + if (optode_frame == "unknown") & (manufacturer == "Gowerlabs"): optode_frame = "head" snirf_data_type = np.array(dat.get('nirs/data1/measurementList1' diff --git a/mne/report/js_and_css/report.js b/mne/report/js_and_css/report.js index 193a4a834d3..dc48bccb8a3 100644 --- a/mne/report/js_and_css/report.js +++ b/mne/report/js_and_css/report.js @@ -216,7 +216,7 @@ const disableGlobalKeyHandler = () => { window.onkeydown = null; } -/* Disbale processing global key events when a search box is active */ +/* Disable processing global key events when a search box is active */ const disableGlobalKeysInSearchBox = () => { const searchBoxElements = document.querySelectorAll('input.search-input'); searchBoxElements.forEach((el) => { diff --git a/mne/simulation/raw.py b/mne/simulation/raw.py index ca29c4b5bc9..d8f2585c08a 100644 --- a/mne/simulation/raw.py +++ b/mne/simulation/raw.py @@ -562,7 +562,7 @@ def add_chpi(raw, head_pos=None, interp='cos2', n_jobs=None, verbose=None): # turn on cHPI in file data = raw._data data[hpi_pick, :] = hpi_ons.sum() - _log_ch('cHPI status bits enbled and', info, hpi_pick) + _log_ch('cHPI status bits enabled and', info, hpi_pick) sinusoids = 70e-9 * np.sin(2 * np.pi * hpi_freqs[:, np.newaxis] * (np.arange(len(times)) / info['sfreq'])) info = pick_info(info, meg_picks) diff --git a/mne/utils/docs.py b/mne/utils/docs.py index 8c22e3fd846..8f89057ad77 100644 --- a/mne/utils/docs.py +++ b/mne/utils/docs.py @@ -1027,7 +1027,7 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75): docdict['exclude_frontal'] = """ exclude_frontal : bool If True, exclude points that have both negative Z values - (below the nasion) and positivy Y values (in front of the LPA/RPA). + (below the nasion) and positive Y values (in front of the LPA/RPA). """ docdict['export_edf_note'] = """ diff --git a/mne/viz/_brain/_brain.py b/mne/viz/_brain/_brain.py index f25724c7528..fecb999da20 100644 --- a/mne/viz/_brain/_brain.py +++ b/mne/viz/_brain/_brain.py @@ -2123,7 +2123,7 @@ def add_label(self, label, color=None, alpha=1, scalar_thresh=None, (away from the true border) along the cortical mesh to include as part of the border definition. hemi : str | None - If None, it is assumed to belong to the hemipshere being + If None, it is assumed to belong to the hemisphere being shown. subdir : None | str If a label is specified as name, subdir can be used to indicate @@ -2540,7 +2540,7 @@ def add_foci(self, coords, coords_as_verts=False, map_surface=None, name : str Internal name to use. hemi : str | None - If None, it is assumed to belong to the hemipshere being + If None, it is assumed to belong to the hemisphere being shown. If two hemispheres are being shown, an error will be thrown. resolution : int @@ -2777,7 +2777,7 @@ def add_annotation(self, annot, borders=True, alpha=1, hemi=None, as part of the border definition. %(alpha)s Default is 1. hemi : str | None - If None, it is assumed to belong to the hemipshere being + If None, it is assumed to belong to the hemisphere being shown. If two hemispheres are being shown, data must exist for both hemispheres. remove_existing : bool