Split up `usage_example` into 3 notebooks

Arcadia-Science / arcadia-pycolor

Python package for styling plots according to Arcadia's style guide

MIT License

4 stars 0 forks source link

Split up `usage_example` into 3 notebooks #30

Closed mezarque closed 3 months ago

mezarque commented 3 months ago

PR checklist

[x] Describe the changes you've made.
[x] Describe any tests you have conducted to confirm that your changes behave as expected.

Overview

This PR splits the usage_example.ipynb into three documents:

color_usage.ipynb covering the color, palette, and gradient-associated parts of the API.
style_usage.ipynb covering the matplotlib / seaborn -altering portions of the API under the mpl module.
cvd_usage.ipynb covering the cvd utilities.

Testing

All of the notebooks run just fine; would love feedback on copy and any other examples that would be useful to include in this documentation!

Note

I'd wait to review this PR until #29 is merged, since I merged those changes into the branch I was working on for this.

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

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

keithchev commented 3 months ago

This looks good! I made some inline comments via nbreview. General comments:

I don't think the sections in the notebook need to be numbered, since they aren't dependent on one another and people could skip around and run the cells in any order (for the most part).
I think we'll want to move these notebooks into a docs/ or notebooks/ subdirectory, but this can wait for a later PR (maybe I can do this when I add the quickstart guide, which for now will be another notebook).

mezarque commented 3 months ago

Ok, I addressed your comments! I'll let you handle the re-arrangement of things. I've also left the paths for saving the PDF files in place for now; probably we want to put them into a folder that's then added to the .gitignore to avoid committing those PDFs in the future.

In the style_usage.ipynb I also added a section that explicitly explains that the colors / gradients are registered to matplotlib and accessible by name, as I think it's a nice convenience feature that wasn't clearly explained before.