matplotlib / matplotlib/ipympl
Documentation
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 1.7k
- Forks
- 234
- PR merge metrics
- No merged PRs in 30d
Description
There is now a lot of really nice functionality in ipympl, but it is hard to find. The in-depth documentation at ipywidgets is a really good supporting resource, but some aspects (like `display(fig.canvas)` and not `display(fig)` need to be clearly expressed.
I'm happy to write documentation for ipympl, but to do that we need some sort of framework to write in. Can someone help with this?
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
The issue names no files or tests; start by reviewing ipympl's existing documentation alongside the in-depth ipywidgets documentation. Define a documentation framework for ipympl and clearly explain the differing uses of `display(fig.canvas)` and `display(fig)`; the issue does not specify further completion criteria.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter, jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100