mne-tools / mne-tools/mne-python
Docstring of `mne.viz.plot_topomap()` incorrect
Open
Nobody has claimed this yet.
DOC
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
The docstring of mne.viz.plot_topomap() is incorrect. The descriptions of contours and cmap refer to an argument colorbar which does not exist:
https://mne.tools/stable/generated/mne.viz.plot_topomap.html
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
Start at the mne.viz.plot_topomap() entry point and compare its docstring with the rendered documentation at the linked URL. Check the descriptions of contours and cmap, then update the wording so they no longer refer to the nonexistent colorbar argument and verify the generated documentation reflects the correction.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100