Add test_add_forward

Author: vferat

mne/report/report.py

@@ -1559,7 +1559,7 @@ def add_forward(
             subjects_dir=subjects_dir,
             title=title,
             image_format=self.image_format,
-            section=title,
+            section=section,
             tags=tags,
             replace=replace,
         )
@@ -3600,7 +3600,7 @@ def _add_forward(
             replace=replace,
         )
 
-        if self.subject:
+        if subject:
             src = forward["src"]
             trans = forward["mri_head_t"]
             # Alignment
@@ -3615,7 +3615,7 @@ def _add_forward(
                 eeg=dict(original=0.2, projected=0.8),
                 coord_frame="mri",
             )
-            img, caption = _iterate_trans_views(
+            img, _ = _iterate_trans_views(
                 function=plot_alignment,
                 alpha=0.5,
                 max_width=self.img_max_width,
@@ -3666,7 +3666,7 @@ def _add_forward(
                 coord_frame="mri",
                 surfaces=surfaces,
             )
-            img, caption = _iterate_alignment_views(
+            img, _ = _iterate_alignment_views(
                 function=plot_alignment,
                 alpha=0.5,
                 max_width=self.img_max_width,

mne/report/tests/test_report.py

@@ -514,6 +514,28 @@ def test_add_bem_n_jobs(n_jobs, monkeypatch):
     assert 0.778 < corr < 0.80
 
 
+@pytest.mark.filterwarnings("ignore:Distances could not be calculated.*:RuntimeWarning")
+@pytest.mark.slowtest
+@testing.requires_testing_data
+def test_add_forward():
+    report = Report(subjects_dir=subjects_dir, image_format="png")
+    report.add_forward(
+        forward=fwd_fname,
+        subject="sample",
+        subjects_dir=subjects_dir,
+        title="Forward solution",
+    )
+    assert len(report.html) == 4
+
+    report = Report(subjects_dir=subjects_dir, image_format="png")
+    report.add_forward(
+        forward=fwd_fname,
+        subjects_dir=subjects_dir,
+        title="Forward solution",
+    )
+    assert len(report.html) == 1
+
+
 @testing.requires_testing_data
 def test_render_mri_without_bem(tmp_path):
     """Test rendering MRI without BEM for mne report."""
@@ -882,6 +904,7 @@ def test_survive_pickle(tmp_path):
 
 @pytest.mark.slowtest  # ~30 s on Azure Windows
 @testing.requires_testing_data
+@pytest.mark.filterwarnings("ignore:Distances could not be calculated.*:RuntimeWarning")
 def test_manual_report_2d(tmp_path, invisible_fig):
     """Simulate user manually creating report by adding one file at a time."""
     pytest.importorskip("sklearn")

mne/viz/misc.py

@@ -631,6 +631,7 @@ def plot_bem(
 
         .. versionchanged:: 0.20
            All sources are shown on the nearest slice rather than some
+           being omitted.
     %(trans)s
         .. versionadded:: 1.9
     show : bool