minor fixes

Author: sappelhoff

eeg_positions/compute.py

@@ -341,7 +341,7 @@ def get_elec_coords(
             elec_names_replaced[alias] = name
         else:
             # however, some cases are specified using an "alias+(x, y, z)" format
-            # we compute these electrode as the last positions (special treatment)
+            # we compute these electrodes as the last positions (special treatment)
             assert "+(" in alias
             elec_names_special.append(alias)
             alias_name, _ = alias.split("+")

examples/use_elec_names.py

@@ -7,7 +7,7 @@
 """  # noqa: D400 D205
 
 # %%
-# We need to import some functions
+# We need to import some functions:
 
 from pprint import pprint
 
@@ -27,11 +27,10 @@
 
 # %%
 # A keen eye may have identified some "odd" electrodes, that are not really part
-# of the 10-20, 10-10, or 10-05 systems: ``'A1', 'A2', 'M1', 'M2'``
+# of the 10-20, 10-10, or 10-05 systems. For example: ``'A1', 'M1'``
 #
-# These are supplied with ``eeg_positions`` for convenience as so-called "alias"
-# positions. See below:
-
+# These and others are supplied with ``eeg_positions`` for convenience as so-called
+# "alias" positions. See below:
 
 alias_mapping = get_alias_mapping()
 for key, val in alias_mapping.items():
@@ -49,13 +48,14 @@
 # electrodes!**
 
 # Just use `elec_names`
+elec_names = ["A1", "A2", "FC3", "CP4", "M1", "LPA", "RPA", "T10"]
 coords = get_elec_coords(
-    elec_names=["A1", "A2", "FC3", "CP4", "M1", "LPA", "RPA", "T10"],
+    elec_names=elec_names,
     drop_landmarks=False,
     dim="3d",
 )
 
-coords.head()
+coords.head(n=len(elec_names))
 
 # %%
 # Plot it, and see how close LPA and A1 (and RPA and A2) are in space.

examples/use_mne.py

@@ -6,7 +6,6 @@
 For more information, check out these MNE resources:
 
 - https://mne.tools/dev/auto_tutorials/intro/plot_40_sensor_locations.html
-- https://mne.tools/dev/auto_examples/visualization/plot_eeglab_head_sphere.html
 
 .. currentmodule:: eeg_positions
 """  # noqa: D400 D205
@@ -31,8 +30,8 @@
 
 # %%
 # Now let's have a look at plotting this in 3D.
+# But let's pick a system that has fewer electrodes.
 
-# but let's pick a system that has fewer electrodes
 coords = get_elec_coords(system="1010", as_mne_montage=True)
 
 fig = coords.plot(kind="3d")

tests/test_compute.py

@@ -41,6 +41,7 @@ def test_get_elec_coords(
     )
 
     if not as_mne_montage:
+        # out is pd.DataFrame, assert there are no NaNs in any cell
         assert (out.isnull().sum() == 0).all()