Merge pull request #112 from yarikoptic/enh-codespell

codespell: action (to prevent typos in the future), config + typos fixed 539d80e
netneurolab · Nov 27, 2023 · eaedd5b · eaedd5b
1 parent 03f8b91
commit eaedd5b
Show file tree

Hide file tree

Showing 98 changed files with 262 additions and 262 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 26c9571c0c4922bcf0740436a811e8f5
+config: 414d20d26629b33fa54cc5fc25a6c9e8
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/_downloads/a04ac8d81d8fed9e456dd9e2eb4c4519/plot_fetch_datasets.py b/_downloads/a04ac8d81d8fed9e456dd9e2eb4c4519/plot_fetch_datasets.py
@@ -72,7 +72,7 @@
 print(tags)
 
 ###############################################################################
-# Tags can be used as a keyword argumnet with :func:`~.available_annotations`.
+# Tags can be used as a keyword argument with :func:`~.available_annotations`.
 # You can supply either a single tag or a list of tags. Note that supplying a
 # list will only return those annotations that match ALL supplied tags:
 

diff --git a/_downloads/c240f18f4239f87d644a1262f01a7969/plot_fetch_datasets.ipynb b/_downloads/c240f18f4239f87d644a1262f01a7969/plot_fetch_datasets.ipynb
@@ -119,7 +119,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Tags can be used as a keyword argumnet with :func:`~.available_annotations`.\nYou can supply either a single tag or a list of tags. Note that supplying a\nlist will only return those annotations that match ALL supplied tags:\n\n"
+        "Tags can be used as a keyword argument with :func:`~.available_annotations`.\nYou can supply either a single tag or a list of tags. Note that supplying a\nlist will only return those annotations that match ALL supplied tags:\n\n"
       ]
     },
     {

diff --git a/_modules/index.html b/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; neuromaps 0+untagged.1.ge1f4fcb documentation</title>
+  <title>Overview: module code &mdash; neuromaps 0+untagged.1.g539d80e documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/sg_gallery.css" type="text/css" />
@@ -39,7 +39,7 @@
               <img src="../_static/neuromaps_logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0+untagged.1.ge1f4fcb
+                0+untagged.1.g539d80e
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

diff --git a/_modules/neuromaps/datasets/annotations.html b/_modules/neuromaps/datasets/annotations.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>neuromaps.datasets.annotations &mdash; neuromaps 0+untagged.1.ge1f4fcb documentation</title>
+  <title>neuromaps.datasets.annotations &mdash; neuromaps 0+untagged.1.g539d80e documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/sg_gallery.css" type="text/css" />
@@ -39,7 +39,7 @@
               <img src="../../../_static/neuromaps_logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0+untagged.1.ge1f4fcb
+                0+untagged.1.g539d80e
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -203,7 +203,7 @@ <h1>Source code for neuromaps.datasets.annotations</h1><div class="highlight"><p
 <span class="sd">        Values on which to match annotations. If not specified annotations with</span>
 <span class="sd">        any value for the relevant key will be matched. Default: None</span>
 <span class="sd">    return_restricted : bool, optional</span>
-<span class="sd">        Whether to return restricted annotations. These will only be accesible</span>
+<span class="sd">        Whether to return restricted annotations. These will only be accessible</span>
 <span class="sd">        with a valid OSF token. Default: True</span>
 
 <span class="sd">    Returns</span>
@@ -227,7 +227,7 @@ <h1>Source code for neuromaps.datasets.annotations</h1><div class="highlight"><p
 <span class="sd">    Parameters</span>
 <span class="sd">    ----------</span>
 <span class="sd">    return_restricted : bool, optional</span>
-<span class="sd">        Whether to return restricted annotations. These will only be accesible</span>
+<span class="sd">        Whether to return restricted annotations. These will only be accessible</span>
 <span class="sd">        with a valid OSF token. Default: True</span>
 
 
@@ -298,7 +298,7 @@ <h1>Source code for neuromaps.datasets.annotations</h1><div class="highlight"><p
                         <span class="n">source</span><span class="o">=</span><span class="n">source</span><span class="p">,</span> <span class="n">desc</span><span class="o">=</span><span class="n">desc</span><span class="p">,</span> <span class="n">space</span><span class="o">=</span><span class="n">space</span><span class="p">,</span> <span class="n">den</span><span class="o">=</span><span class="n">den</span><span class="p">,</span>
                         <span class="n">res</span><span class="o">=</span><span class="n">res</span><span class="p">,</span> <span class="n">hemi</span><span class="o">=</span><span class="n">hemi</span><span class="p">,</span> <span class="n">tags</span><span class="o">=</span><span class="n">tags</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="nb">format</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">verbose</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
-        <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Identified </span><span class="si">{</span><span class="nb">len</span><span class="p">(</span><span class="n">info</span><span class="p">)</span><span class="si">}</span><span class="s1"> datsets matching specified parameters&#39;</span><span class="p">)</span>
+        <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Identified </span><span class="si">{</span><span class="nb">len</span><span class="p">(</span><span class="n">info</span><span class="p">)</span><span class="si">}</span><span class="s1"> datasets matching specified parameters&#39;</span><span class="p">)</span>
 
     <span class="c1"># get session for requests</span>
     <span class="n">session</span> <span class="o">=</span> <span class="n">_get_session</span><span class="p">(</span><span class="n">token</span><span class="o">=</span><span class="n">token</span><span class="p">)</span>

diff --git a/_modules/neuromaps/datasets/atlases.html b/_modules/neuromaps/datasets/atlases.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>neuromaps.datasets.atlases &mdash; neuromaps 0+untagged.1.ge1f4fcb documentation</title>
+  <title>neuromaps.datasets.atlases &mdash; neuromaps 0+untagged.1.g539d80e documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/sg_gallery.css" type="text/css" />
@@ -39,7 +39,7 @@
               <img src="../../../_static/neuromaps_logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0+untagged.1.ge1f4fcb
+                0+untagged.1.g539d80e
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">

diff --git a/_modules/neuromaps/datasets/contributions.html b/_modules/neuromaps/datasets/contributions.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>neuromaps.datasets.contributions &mdash; neuromaps 0+untagged.1.ge1f4fcb documentation</title>
+  <title>neuromaps.datasets.contributions &mdash; neuromaps 0+untagged.1.g539d80e documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/sg_gallery.css" type="text/css" />
@@ -39,7 +39,7 @@
               <img src="../../../_static/neuromaps_logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0+untagged.1.ge1f4fcb
+                0+untagged.1.g539d80e
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">

diff --git a/_modules/neuromaps/images.html b/_modules/neuromaps/images.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>neuromaps.images &mdash; neuromaps 0+untagged.1.ge1f4fcb documentation</title>
+  <title>neuromaps.images &mdash; neuromaps 0+untagged.1.g539d80e documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/sg_gallery.css" type="text/css" />
@@ -39,7 +39,7 @@
               <img src="../../_static/neuromaps_logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0+untagged.1.ge1f4fcb
+                0+untagged.1.g539d80e
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/_modules/neuromaps/nulls/nulls.html b/_modules/neuromaps/nulls/nulls.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>neuromaps.nulls.nulls &mdash; neuromaps 0+untagged.1.ge1f4fcb documentation</title>
+  <title>neuromaps.nulls.nulls &mdash; neuromaps 0+untagged.1.g539d80e documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/sg_gallery.css" type="text/css" />
@@ -39,7 +39,7 @@
               <img src="../../../_static/neuromaps_logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0+untagged.1.ge1f4fcb
+                0+untagged.1.g539d80e
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">

diff --git a/_modules/neuromaps/parcellate.html b/_modules/neuromaps/parcellate.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>neuromaps.parcellate &mdash; neuromaps 0+untagged.1.ge1f4fcb documentation</title>
+  <title>neuromaps.parcellate &mdash; neuromaps 0+untagged.1.g539d80e documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/sg_gallery.css" type="text/css" />
@@ -39,7 +39,7 @@
               <img src="../../_static/neuromaps_logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0+untagged.1.ge1f4fcb
+                0+untagged.1.g539d80e
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/_modules/neuromaps/plotting.html b/_modules/neuromaps/plotting.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>neuromaps.plotting &mdash; neuromaps 0+untagged.1.ge1f4fcb documentation</title>
+  <title>neuromaps.plotting &mdash; neuromaps 0+untagged.1.g539d80e documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/sg_gallery.css" type="text/css" />
@@ -39,7 +39,7 @@
               <img src="../../_static/neuromaps_logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0+untagged.1.ge1f4fcb
+                0+untagged.1.g539d80e
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -201,7 +201,7 @@ <h1>Source code for neuromaps.plotting</h1><div class="highlight"><pre>
 <span class="sd">    Returns</span>
 <span class="sd">    -------</span>
 <span class="sd">    colors : (F,) array_like</span>
-<span class="sd">        Updated facecolors with approriate shading</span>
+<span class="sd">        Updated facecolors with appropriate shading</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="n">hemi_view</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;R&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;lateral&#39;</span><span class="p">:</span> <span class="s1">&#39;medial&#39;</span><span class="p">,</span> <span class="s1">&#39;medial&#39;</span><span class="p">:</span> <span class="s1">&#39;lateral&#39;</span><span class="p">}}</span>

diff --git a/_modules/neuromaps/points.html b/_modules/neuromaps/points.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>neuromaps.points &mdash; neuromaps 0+untagged.1.ge1f4fcb documentation</title>
+  <title>neuromaps.points &mdash; neuromaps 0+untagged.1.g539d80e documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/sg_gallery.css" type="text/css" />
@@ -39,7 +39,7 @@
               <img src="../../_static/neuromaps_logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0+untagged.1.ge1f4fcb
+                0+untagged.1.g539d80e
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/_modules/neuromaps/resampling.html b/_modules/neuromaps/resampling.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>neuromaps.resampling &mdash; neuromaps 0+untagged.1.ge1f4fcb documentation</title>
+  <title>neuromaps.resampling &mdash; neuromaps 0+untagged.1.g539d80e documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/sg_gallery.css" type="text/css" />
@@ -39,7 +39,7 @@
               <img src="../../_static/neuromaps_logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0+untagged.1.ge1f4fcb
+                0+untagged.1.g539d80e
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/_modules/neuromaps/stats.html b/_modules/neuromaps/stats.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>neuromaps.stats &mdash; neuromaps 0+untagged.1.ge1f4fcb documentation</title>
+  <title>neuromaps.stats &mdash; neuromaps 0+untagged.1.g539d80e documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/sg_gallery.css" type="text/css" />
@@ -39,7 +39,7 @@
               <img src="../../_static/neuromaps_logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0+untagged.1.ge1f4fcb
+                0+untagged.1.g539d80e
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/_modules/neuromaps/transforms.html b/_modules/neuromaps/transforms.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>neuromaps.transforms &mdash; neuromaps 0+untagged.1.ge1f4fcb documentation</title>
+  <title>neuromaps.transforms &mdash; neuromaps 0+untagged.1.g539d80e documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/sg_gallery.css" type="text/css" />
@@ -39,7 +39,7 @@
               <img src="../../_static/neuromaps_logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0+untagged.1.ge1f4fcb
+                0+untagged.1.g539d80e
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -126,7 +126,7 @@ Reference API
 
 .. _ref_points:
 
-:mod:`neuromaps.points` - Triangle mesh utilites
+:mod:`neuromaps.points` - Triangle mesh utilities
 ------------------------------------------------
 .. automodule:: neuromaps.points
     :no-members:

diff --git a/_sources/auto_examples/plot_fetch_datasets.rst.txt b/_sources/auto_examples/plot_fetch_datasets.rst.txt
@@ -53,7 +53,7 @@ function that can fetch any of the atlases provided with ``neuromaps``:
  .. code-block:: none
 
     Downloading data from https://files.osf.io/v1/resources/4mw3a/providers/osfstorage/60b684b53a6df1021bd4df2d ...
-     ...done. (3 seconds, 0 min)
+     ...done. (2 seconds, 0 min)
     Extracting data from /home/runner/neuromaps-data/ac53e497d7d6c6379ee7bd7bda6e0267/fsLR32k.tar.gz..... done.
     dict_keys(['midthickness', 'inflated', 'veryinflated', 'sphere', 'medial', 'sulc', 'vaavg'])
 
@@ -207,7 +207,7 @@ functions:
 
 .. GENERATED FROM PYTHON SOURCE LINES 75-78
 
-Tags can be used as a keyword argumnet with :func:`~.available_annotations`.
+Tags can be used as a keyword argument with :func:`~.available_annotations`.
 You can supply either a single tag or a list of tags. Note that supplying a
 list will only return those annotations that match ALL supplied tags:
 
@@ -306,7 +306,7 @@ information please refer to the :ref:`API reference <ref_datasets>`.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 4.999 seconds)
+   **Total running time of the script:** (0 minutes 4.079 seconds)
 
 
 .. _sphx_glr_download_auto_examples_plot_fetch_datasets.py:

diff --git a/_sources/auto_examples/plot_spatial_nulls.rst.txt b/_sources/auto_examples/plot_spatial_nulls.rst.txt
@@ -66,7 +66,7 @@ dictionary will always be returned if multiple annotations match our query.)
  .. code-block:: none
 
     Downloading data from https://files.osf.io/v1/resources/4mw3a/providers/osfstorage/60c22953f3ce9401fa24e651 ...
-     ...done. (2 seconds, 0 min)
+     ...done. (3 seconds, 0 min)
     Neurosynth:  /home/runner/neuromaps-data/annotations/neurosynth/cogpc1/MNI152/source-neurosynth_desc-cogpc1_space-MNI152_res-2mm_feature.nii.gz
     Gene PC1:  ['/home/runner/neuromaps-data/annotations/abagen/genepc1/fsaverage/source-abagen_desc-genepc1_space-fsaverage_den-10k_hemi-L_feature.func.gii', '/home/runner/neuromaps-data/annotations/abagen/genepc1/fsaverage/source-abagen_desc-genepc1_space-fsaverage_den-10k_hemi-R_feature.func.gii']
 
@@ -106,9 +106,9 @@ The data returned will always be pre-loaded nibabel image instances:
  .. code-block:: none
 
     Downloading data from https://files.osf.io/v1/resources/4mw3a/providers/osfstorage/60b684c03a6df1020ed525f6 ...
-     ...done. (3 seconds, 0 min)
+     ...done. (2 seconds, 0 min)
     Extracting data from /home/runner/neuromaps-data/529deda7a30dc28b5106317477efbaf2/regfusion.tar.gz..... done.
-    (<nibabel.gifti.gifti.GiftiImage object at 0x7f849d110110>, <nibabel.gifti.gifti.GiftiImage object at 0x7f849c0d3210>) (<nibabel.gifti.gifti.GiftiImage object at 0x7f849cdf2810>, <nibabel.gifti.gifti.GiftiImage object at 0x7f849d96f150>)
+    (<nibabel.gifti.gifti.GiftiImage object at 0x7f01a2f0d110>, <nibabel.gifti.gifti.GiftiImage object at 0x7f01a1724190>) (<nibabel.gifti.gifti.GiftiImage object at 0x7f01a1724a50>, <nibabel.gifti.gifti.GiftiImage object at 0x7f01a2f50c90>)
 
 
 
@@ -221,7 +221,7 @@ null maps; they have (nearly) identical function signatures, so refer to the
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 8.650 seconds)
+   **Total running time of the script:** (0 minutes 9.365 seconds)
 
 
 .. _sphx_glr_download_auto_examples_plot_spatial_nulls.py: