In the following docstring instead of using the python type as description, could we use a glossary term instead?
|
dig : list of dict | None |
|
The Polhemus digitization data in head coordinates. |
|
See Notes for more information. |
Or maybe we should keep the python type and link the term in the description.
dig : list of dict | None
The Polhemus :term:`digitization` data in head coordinates.
See Notes for more information.
WDYT?
cc: @drammock, @larsoner, @agramfort
Maybe something like this could work:
numpydoc_xref_aliases = {
'Popen': 'python:subprocess.Popen',
'file-like': ':term:`file-like <python:file object>`',
...
# MNE
'Label': 'mne.Label', 'Forward': 'mne.Forward', 'Evoked': 'mne.Evoked',
...
'Transform': 'mne.transforms.Transform',
# MNE-terms
'digitization': ':term:`digitization`',
}
Suggested term
digitization (abbr. dig)
digpoint
Suggested definition
digitization: list of digpoints
digpoint: Dictionary contaning Polhemus digitization data (kind, identifier, position, and coord_frame)
@drammock feel free to rephrase the whole thing ;) (or push me to do it)
In the following docstring instead of using the python type as description, could we use a glossary term instead?
mne-python/mne/io/meas_info.py
Lines 205 to 207 in adb7086
Or maybe we should keep the python type and link the term in the description.
WDYT?
cc: @drammock, @larsoner, @agramfort
Maybe something like this could work:
Suggested term
digitization (abbr. dig)
digpoint
Suggested definition
digitization: list of digpoints
digpoint: Dictionary contaning
Polhemusdigitization data (kind, identifier, position, and coord_frame)@drammock feel free to rephrase the whole thing ;) (or push me to do it)