DOC: Diátaxis application to Source Tutorial part 2: Defacing Example

.github/workflows/credit.yml

@@ -37,10 +37,10 @@ jobs:
           set -xeo pipefail
           git config --global user.email "50266005+mne-bot@users.noreply.github.com"
           git config --global user.name "mne[bot]"
-          BRANCH=credit/$GITHUB_RUN_ID
+          BRANCH=credit/$(date '+%Y%m%d')
           git checkout -b $BRANCH
           git commit -am "mne[bot]: Update code credit"
           git push origin $BRANCH
-          PR_NUM=$(gh pr create --base main --head $BRANCH --title "MAINT: Update code credit" --body "Created by credit [GitHub action](https://github.com/mne-tools/mne-python/actions/runs/${{ github.run_id }}). <br> <br> *Adjustments may need to be made to \`doc/changes/credit_tools.py\` or \`.mailmap\` etc. to get CircleCI to pass.*" --label "no-changelog-entry-needed")
+          PR_NUM=$(gh pr create --base main --head $BRANCH --title "MAINT: Update code credit" --body "Created by credit [GitHub action](https://github.com/mne-tools/mne-python/actions/runs/${{ github.run_id }}). <br> <br> *Adjustments may need to be made to \`doc/sphinxext/credit_tools.py\` or \`.mailmap\` etc. to get CircleCI to pass.*" --label "no-changelog-entry-needed")
           echo "Opened https://github.com/mne-tools/mne-python/pull/${PR_NUM}" >> $GITHUB_STEP_SUMMARY
         if: steps.status.outputs.dirty == 'true'

.mailmap

@@ -20,6 +20,7 @@ Andrew Dykstra <andrew.r.dykstra@gmail.com>
 Andrew Quinn <AJQuinn@users.noreply.github.com> AJQuinn <AJQuinn@users.noreply.github.com>
 Andy Gilbert <7andy121@gmail.com> Andrew Gilbert <adgilbert21@icloud.com>
 Andy Gilbert <7andy121@gmail.com> Andrew Gilbert <andrew.gilbert@irhythmtech.com>
+Aniket Singh Yadav <148300120+Aniketsy@users.noreply.github.com> Aniket <148300120+Aniketsy@users.noreply.github.com>
 Anna Padee <anna.padee@gmail.com> apadee <44297909+apadee@users.noreply.github.com>
 Anne-Sophie Dubarry <as_dub@hotmail.com> annesodub <as_dub@hotmail.com>
 Archit Singhal <43236121+architsinghal-mriirs@users.noreply.github.com> archit singhal <zyphergiest@pop-os.localdomain>

doc/_includes/institutional-partners.rst

@@ -14,31 +14,31 @@ Current partners
 ~~~~~~~~~~~~~~~~
 
 - `Aalto-yliopiston perustieteiden korkeakoulu <https://sci.aalto.fi/>`_
-- `AE Studio <https://ae.studio/>`_
-- `Athinoula A. Martinos Center for Biomedical Imaging <https://martinos.org/>`_
-- `Children’s Hospital of Philadelphia Research Institute <https://www.research.chop.edu/imaging/>`_
 - `Donders Institute for Brain, Cognition and Behaviour at Radboud University <https://www.ru.nl/donders/>`_
-- `Harvard Medical School <https://hms.harvard.edu/>`_
-- `Institut national de recherche en informatique et en automatique <https://www.inria.fr/>`_
 - `Karl-Franzens-Universität Graz <https://www.uni-graz.at/>`_
-- `Massachusetts General Hospital <https://www.massgeneral.org/>`_
-- `Max-Planck-Institut für Bildungsforschung <https://www.mpib-berlin.mpg.de/>`_
-- `SWPS Uniwersytet Humanistycznospołeczny <https://www.swps.pl/>`_
 - `University of Washington <https://www.washington.edu/>`_
 
 Former partners
 ~~~~~~~~~~~~~~~
 
 - `Aarhus Universitet <https://www.au.dk/>`_
+- `AE Studio <https://ae.studio/>`_
+- `Athinoula A. Martinos Center for Biomedical Imaging <https://martinos.org/>`_
 - `Berkeley Institute for Data Science <https://bids.berkeley.edu/>`_
 - `Boston University <https://www.bu.edu/>`_
+- `Children’s Hospital of Philadelphia Research Institute <https://www.research.chop.edu/imaging/>`_
 - `Commissariat à l’énergie atomique et aux énergies alternatives <https://www.cea.fr/>`_
 - `Fondation Campus Biotech Geneva <https://fcbg.ch/>`_
 - `Forschungszentrum Jülich <https://www.fz-juelich.de/>`_
+- `Harvard Medical School <https://hms.harvard.edu/>`_
 - `Institut du Cerveau et de la Moelle épinière <https://icm-institute.org/>`_
 - `Institut national de la santé et de la recherche médicale <https://www.inserm.fr/>`_
+- `Institut national de recherche en informatique et en automatique <https://www.inria.fr/>`_
+- `Massachusetts General Hospital <https://www.massgeneral.org/>`_
 - `Massachusetts Institute of Technology <https://web.mit.edu/>`_
+- `Max-Planck-Institut für Bildungsforschung <https://www.mpib-berlin.mpg.de/>`_
 - `Macquarie University <https://www.mq.edu.au/>`_
 - `New York University <https://www.nyu.edu/>`_
+- `SWPS Uniwersytet Humanistycznospołeczny <https://www.swps.pl/>`_
 - `Technische Universität Ilmenau <https://www.tu-ilmenau.de/>`_
 - `Télécom ParisTech <https://www.telecom-paris.fr/>`_

doc/changes/dev/13674.other.rst

@@ -0,0 +1 @@
+Improve documentation of return values to clarify that methods typically return the original instance type for chaining purposes, by `Aniket Singh Yadav`_.

doc/conf.py

@@ -318,13 +318,18 @@
 numpydoc_xref_ignore = {
     # words
     "and",
+    "as",
     "between",
+    "data",
     "instance",
     "instances",
+    "input",
     "of",
     "default",
+    "same",
     "shape",
     "or",
+    "the",
     "with",
     "length",
     "pair",
@@ -987,7 +992,7 @@ def fix_sklearn_inherited_docstrings(app, what, name, obj, options, lines):
             klass="only-dark",
         ),
         dict(
-            name="Commissariat à l´énergie atomique et aux énergies alternatives",  # noqa E501
+            name="Commissariat à l´énergie atomique et aux énergies alternatives",
             img="CEA.png",
             url="http://www.cea.fr/",
             size=md,
@@ -1092,7 +1097,7 @@ def fix_sklearn_inherited_docstrings(app, what, name, obj, options, lines):
             klass="only-dark",
         ),
         dict(
-            name="Institut national de recherche en informatique et en automatique",  # noqa E501
+            name="Institut national de recherche en informatique et en automatique",
             img="inria.png",
             url="https://www.inria.fr/",
             size=xl,
@@ -1212,7 +1217,7 @@ def fix_sklearn_inherited_docstrings(app, what, name, obj, options, lines):
         ),
         dict(
             title="Machine Learning",
-            text="Advanced decoding models including time general\u00adiza\u00adtion.",  # noqa E501
+            text="Advanced decoding models including time general\u00adiza\u00adtion.",
             url="auto_tutorials/machine-learning/50_decoding.html",
             img="sphx_glr_50_decoding_006.png",
             alt="Decoding",
@@ -1226,14 +1231,14 @@ def fix_sklearn_inherited_docstrings(app, what, name, obj, options, lines):
         ),
         dict(
             title="Statistics",
-            text="Parametric and non-parametric, permutation tests and clustering.",  # noqa E501
+            text="Parametric and non-parametric, permutation tests and clustering.",
             url="auto_tutorials/stats-source-space/index.html",
             img="sphx_glr_20_cluster_1samp_spatiotemporal_001.png",
             alt="Clusters",
         ),
         dict(
             title="Connectivity",
-            text="All-to-all spectral and effective connec\u00adtivity measures.",  # noqa E501
+            text="All-to-all spectral and effective connec\u00adtivity measures.",
             url="https://mne.tools/mne-connectivity/stable/auto_examples/mne_inverse_label_connectivity.html",  # noqa E501
             img="https://mne.tools/mne-connectivity/stable/_images/sphx_glr_mne_inverse_label_connectivity_001.png",  # noqa E501
             alt="Connectivity",

doc/sphinxext/credit_tools.py

@@ -63,6 +63,7 @@
     "akshay0724": "Akshay",  # 4046, TODO: Check singleton
     "alexandra.corneyllie": "Alexandra Corneyllie",  # 7600
     "alexandra": "Alexandra Corneyllie",  # 7600
+    "Aniket": "Aniket Singh Yadav",  # 13672
     "AnneSo": "Anne-Sophie Dubarry",  # 4910
     "Basile": "Basile Pinsard",  # 1791
     "Bru": "Bruno Aristimunha",  # 13489

doc/sphinxext/prs/13024.json

@@ -0,0 +1,43 @@
+{
+  "merge_commit_sha": "a5bf268a1a8645a6b4addc467dec70eb0ec26ce3",
+  "authors": [
+    {
+      "n": "Victor Férat",
+      "e": "victor.ferat@live.Fr"
+    },
+    {
+      "n": "pre-commit-ci[bot]",
+      "e": "66853113+pre-commit-ci[bot]@users.noreply.github.com"
+    },
+    {
+      "n": "Marijn van Vliet",
+      "e": "w.m.vanvliet@gmail.com"
+    },
+    {
+      "n": "Eric Larson",
+      "e": "larson.eric.d@gmail.com"
+    }
+  ],
+  "changes": {
+    "doc/changes/dev/13024.bugfix.rst": {
+      "a": 1,
+      "d": 0
+    },
+    "mne/bem.py": {
+      "a": 61,
+      "d": 29
+    },
+    "mne/commands/mne_make_scalp_surfaces.py": {
+      "a": 8,
+      "d": 0
+    },
+    "mne/commands/tests/test_commands.py": {
+      "a": 102,
+      "d": 24
+    },
+    "mne/tests/test_bem.py": {
+      "a": 25,
+      "d": 3
+    }
+  }
+}

doc/sphinxext/prs/13196.json

@@ -0,0 +1,67 @@
+{
+  "merge_commit_sha": "437d79be7c5fb855a81d44da30bf9a51c9f60413",
+  "authors": [
+    {
+      "n": "Konstantinos Tsilimparis",
+      "e": null
+    },
+    {
+      "n": "pre-commit-ci[bot]",
+      "e": "66853113+pre-commit-ci[bot]@users.noreply.github.com"
+    },
+    {
+      "n": "Eric Larson",
+      "e": "larson.eric.d@gmail.com"
+    }
+  ],
+  "changes": {
+    "doc/api/preprocessing.rst": {
+      "a": 1,
+      "d": 0
+    },
+    "doc/changes/dev/13196.newfeature.rst": {
+      "a": 1,
+      "d": 0
+    },
+    "doc/changes/names.inc": {
+      "a": 1,
+      "d": 0
+    },
+    "examples/preprocessing/interpolate_to.py": {
+      "a": 71,
+      "d": 4
+    },
+    "mne/channels/__init__.pyi": {
+      "a": 2,
+      "d": 0
+    },
+    "mne/channels/channels.py": {
+      "a": 76,
+      "d": 133
+    },
+    "mne/channels/data/canonical_meg/ctf151.csv": {
+      "a": 152,
+      "d": 0
+    },
+    "mne/channels/data/canonical_meg/ctf275.csv": {
+      "a": 275,
+      "d": 0
+    },
+    "mne/channels/data/canonical_meg/neuromag306.csv": {
+      "a": 307,
+      "d": 0
+    },
+    "mne/channels/interpolation.py": {
+      "a": 138,
+      "d": 2
+    },
+    "mne/channels/montage.py": {
+      "a": 119,
+      "d": 0
+    },
+    "mne/channels/tests/test_interpolation.py": {
+      "a": 25,
+      "d": 0
+    }
+  }
+}

doc/sphinxext/prs/13490.json

@@ -0,0 +1,83 @@
+{
+  "merge_commit_sha": "4051f3102d39fd2dcc85e0b3079a86c11289816c",
+  "authors": [
+    {
+      "n": "Daniel McCloy",
+      "e": null
+    },
+    {
+      "n": "Carina Forster",
+      "e": "carinaforster0611@gmail.com"
+    },
+    {
+      "n": "Thomas S. Binns",
+      "e": "t.s.binns@outlook.com"
+    },
+    {
+      "n": "Scott Huberty",
+      "e": "52462026+scott-huberty@users.noreply.github.com"
+    },
+    {
+      "n": "Erica Peterson",
+      "e": "nordme@uw.edu"
+    },
+    {
+      "n": "Eric Larson",
+      "e": "larson.eric.d@gmail.com"
+    },
+    {
+      "n": "pre-commit-ci[bot]",
+      "e": "66853113+pre-commit-ci[bot]@users.noreply.github.com"
+    }
+  ],
+  "changes": {
+    ".github/workflows/spec_zero.yml": {
+      "a": 15,
+      "d": 7
+    },
+    ".github/workflows/tests.yml": {
+      "a": 12,
+      "d": 3
+    },
+    "environment.yml": {
+      "a": 11,
+      "d": 11
+    },
+    "pyproject.toml": {
+      "a": 40,
+      "d": 30
+    },
+    "tools/check_pyproject_helpers.py": {
+      "a": 61,
+      "d": 0
+    },
+    "tools/dev/spec_zero_update_versions.py": {
+      "a": 29,
+      "d": 22
+    },
+    "tools/github_actions_check_old.py": {
+      "a": 0,
+      "d": 35
+    },
+    "tools/github_actions_check_old_env.py": {
+      "a": 68,
+      "d": 0
+    },
+    "tools/github_actions_check_old_lockfile.py": {
+      "a": 68,
+      "d": 0
+    },
+    "tools/github_actions_dependencies.sh": {
+      "a": 28,
+      "d": 6
+    },
+    "tools/github_actions_env_vars.sh": {
+      "a": 5,
+      "d": 6
+    },
+    "tools/pylock.ci-old.toml": {
+      "a": 656,
+      "d": 0
+    }
+  }
+}

doc/sphinxext/prs/13544.json

@@ -0,0 +1,23 @@
+{
+  "merge_commit_sha": "8a11b2e8be48f7844b9b4b907a4a4e8f976b9ab7",
+  "authors": [
+    {
+      "n": "Teemu Taivainen",
+      "e": "ttaiv@outlook.com"
+    },
+    {
+      "n": "Eric Larson",
+      "e": "larson.eric.d@gmail.com"
+    }
+  ],
+  "changes": {
+    "doc/sphinxext/related_software.py": {
+      "a": 2,
+      "d": 1
+    },
+    "doc/sphinxext/related_software_nodeps.txt": {
+      "a": 2,
+      "d": 1
+    }
+  }
+}

doc/sphinxext/prs/13570.json

@@ -0,0 +1,35 @@
+{
+  "merge_commit_sha": "4a5479d6b496dc18bd325919bc6c346ce7563cfb",
+  "authors": [
+    {
+      "n": "Aman Srivastava",
+      "e": null
+    },
+    {
+      "n": "pre-commit-ci[bot]",
+      "e": "66853113+pre-commit-ci[bot]@users.noreply.github.com"
+    },
+    {
+      "n": "Daniel McCloy",
+      "e": "dan@mccloy.info"
+    }
+  ],
+  "changes": {
+    "doc/changes/dev/13570.newfeature.rst": {
+      "a": 3,
+      "d": 0
+    },
+    "doc/changes/names.inc": {
+      "a": 1,
+      "d": 0
+    },
+    "examples/visualization/eeg_on_scalp.py": {
+      "a": 1,
+      "d": 0
+    },
+    "mne/viz/_3d.py": {
+      "a": 23,
+      "d": 0
+    }
+  }
+}