Embed examples into docstrings
Open
Nobody has claimed this yet.
documentation
good first issue
help wanted
- Dominant language
- Jupyter Notebook
- Stars
- 12
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
Once #20 is completed, embed examples currently in sphinx gallery: sidpy/examples/... into the docstrings for each function similar to numpy et al.
Contributor guide
No contributing guide indexed for this repository
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
First check issue #20, since this work depends on it. Review the examples under sidpy/examples/... and the docstrings for each function, then compare how NumPy embeds examples. Done means the relevant Sphinx Gallery examples are incorporated into those function docstrings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- numpy, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100