mne-tools / mne-tools/mne-python
document how to change docstrings when deprecating params
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
Proposed documentation enhancement
we should update https://mne.tools/dev/development/contributing.html#deprecate-with-a-decorator-or-a-warning to have a docstring in the example function, that shows how to use our sphinx roles etc within the param descriptions.
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
Open the contributing guide at the deprecate-with-a-decorator-or-a-warning section and inspect the example function. Add a docstring showing Sphinx roles in its parameter descriptions, then verify that the documentation renders correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100