Arcadia-Science / arcadia-pycolor

Python package for styling plots according to Arcadia's style guide
MIT License
4 stars 0 forks source link

Add plotting tests #28

Closed keithchev closed 3 months ago

keithchev commented 3 months ago

This PR adds integration-like tests that generate realistic plots of various common kinds. They are derived from the notebooks in plot_testing/ and are intended to replace them (so this PR also deletes the notebooks).

This PR also adds a pytest CLI option to save the PDF files generated by these tests in a user-specified directory. This allows for manual inspection of the plots generated by the tests. See the README for details.

Drive-bys

review-notebook-app[bot] commented 3 months ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

keithchev commented 3 months ago

One higher-level question: should we remove the Jupyter notebooks? The goal of those notebooks is to serve as example code for folks to be able to understand how the library can be used in different contexts. Replacing those entirely with the tests prevents users from being able to have more interpretable examples to look at. We don't have to keep those exact notebooks or put them in the same place, but I do think it would be good for us to provide some copypaste-able code for this.

Yeah, makes sense. For now I've added the notebooks back into the plot_testing/ directory but we can move these to a more appropriately named directory later on.