mne-python icon indicating copy to clipboard operation
mne-python copied to clipboard

Too many (duplicate) search results in API docs

Open cbrnr opened this issue 2 months ago • 3 comments

  1. Go to https://mne.tools/dev/index.html
  2. Click the Search icon in the top bar, enter e.g. "read_raw_edf" in the search box, and hit enter
  3. The first three results are (almost identical): mne.io.read_raw_edf mne.io.read_raw_edf (Python function, in mne.io.read_raw_edf) mne.io.read_raw_edf

Specifically, the link to

  • https://mne.tools/dev/generated/mne.io.read_raw_edf.html#mne-io-read-raw-edf
  • https://mne.tools/dev/generated/mne.io.read_raw_edf.html#mne.io.read_raw_edf
  • https://mne.tools/dev/generated/mne.io.read_raw_edf.html

I think there should be only one search result pointing to the documentation of that function (the third one). The other two contain anchors, where the first one doesn't have any effect, and the second one scrolls down one line so that the heading is not visible (not useful IMO).

image

cbrnr avatar Apr 30 '24 09:04 cbrnr