mne-tools / mne-tools/mne-python
DOC: add crossrefs in the info docstring
Open
Nobody has claimed this yet.
DOC
EASY
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
We should add crossrefs in the info docstring to the various MNE functions/methods that can safely change info fields (e.g., inst.rename_channels etc)
mne.{io.Raw | Epochs | Evoked}.add_projmne.{io.Raw | Epochs | Evoked}.del_projmne.{io.Raw | Epochs | Evoked}.set_channel_typesmne.{io.Raw | Epochs | Evoked}.set_meas_date
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
Locate the info docstring in the MNE-Python source and review how cross-references are written elsewhere in the documentation. Add references for the listed add_proj, del_proj, set_channel_types, and set_meas_date methods, along with the existing rename_channels example; the docstring should clearly link to each safe Info-field-changing function or method.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100