mne-tools / mne-tools/mne-python
Too many (duplicate) search results in API docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
- Go to https://mne.tools/dev/index.html
- Click the Search icon in the top bar, enter e.g. "read_raw_edf" in the search box, and hit enter
- 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).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the search for "read_raw_edf" from the MNE dev documentation at mne.tools/dev/index.html and compare the three linked results shown in the issue. Trace how these documentation search entries and anchors are generated; done means the function has one useful result linking to its documentation page without the two redundant anchor variants.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, search
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100