statsmodels / statsmodels/statsmodels
DOC/TST: graphics add notebooks to visually inspect if options work
Open
Nobody has claimed this yet.
comp-docs
comp-graphics
type-test
- Dominant language
- Python
- Stars
- 11.6k
- Forks
- 3.6k
- Avg merge
- 7h 37m
- Merged PRs (30d)
- 96
Description
visual "crowd-testing" ?
We only have smoke test for the plots.
One addition that works both as tests and as documentation would be to add notebooks that just illustrate different options for the plots.
and it would make reviewing a PR for graphics easier
See for example #1861
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
Review the existing plot smoke tests and the example in issue #1861 first. Define a set of notebooks that illustrate different plot options, then verify that they serve both as visual checks for graphics changes and as documentation for reviewers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- data-visualization, documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100