Skip to content

Commit e0cc99b

Browse files
authored
DOC: link to background info on fsaverage (#13249)
1 parent 9849b3e commit e0cc99b

File tree

4 files changed

+6
-3
lines changed

4 files changed

+6
-3
lines changed

doc/documentation/datasets.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,8 @@ fsaverage
398398
:func:`mne.datasets.fetch_fsaverage`
399399

400400
For convenience, we provide a function to separately download and extract the
401-
(or update an existing) fsaverage subject.
401+
(or update an existing) fsaverage subject. See also the
402+
:ref:`background information on fsaverage <fsaverage_background>`.
402403

403404
.. topic:: Examples
404405

mne/datasets/_fsaverage/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
@verbose
1414
def fetch_fsaverage(subjects_dir=None, *, verbose=None):
15-
"""Fetch and update fsaverage.
15+
"""Fetch and update :ref:`fsaverage <fsaverage_background>`.
1616
1717
Parameters
1818
----------

tutorials/forward/10_background_freesurfer.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@
118118
# MNE-Python and FreeSurfer are integrated.
119119
#
120120
#
121+
# .. _fsaverage_background:
122+
#
121123
# 'fsaverage'
122124
# ===========
123125
#

tutorials/forward/35_eeg_no_mri.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
========================================
77
88
This tutorial explains how to compute the forward operator from EEG data
9-
using the standard template MRI subject ``fsaverage``.
9+
using the standard template MRI subject :ref:`fsaverage <fsaverage_background>`.
1010
1111
.. caution:: Source reconstruction without an individual T1 MRI from the
1212
subject will be less accurate. Do not over interpret activity

0 commit comments

Comments
 (0)