Missing API documentation for sample dataset's data_path() (and possibly others)

[hoechenberger]

Proposed documentation enhancement

To figure out what the parameters of datasets.sample.data_path() do, I had to dig into the source code. This is … not great, especially since we constantly ask users to provide MWEs based on sample. I assume this affects other datasets as well, but I only checked sample.

[drammock]

is this the old issue of "vscode doesn't render doccer-based docstrings"? Here's what I see in ipython, no source-code-digging required:

[hoechenberger]

It seems to be caused by this post-hoc injection of the docstring into the function:

mne-python/mne/datasets/sample/sample.py

Lines 20 to 21 in e5086fc

	data_path.__doc__ = _data_path_doc.format(name='sample',
	conf='MNE_DATASETS_SAMPLE_PATH')

And you're right, seems to be limited to Pylance.

[larsoner]

Closing as wontfix dup of #8863 #8218