search

earthlab / matplotcheck

A python package for checking and testing matplotlib plots. We use this for autograding student assignments but there are many other potential use cases including package testing (for packages with plots)!
https://matplotcheck.readthedocs.io
BSD 3-Clause "New" or "Revised" License
18 stars 8 forks source link

examples for a few classes #2

Closed lwasser closed 5 years ago

lwasser commented 6 years ago

hey @kdcurry it would be really great to have a bit of documentation embedded in some of the classes. If you have a bit of time this week (i know it is tight!) can you kindly have a look at other packages like: https://github.com/scikit-image/scikit-image/blob/master/skimage/feature/brief.py and take not of how they have examples of how things would be called within the classes / methods / functions. please let me know if this doesn't make sense. a few of these would be very nice.

lwasser commented 6 years ago

just making sure you see this too @kdcurry ...

kdcurry commented 6 years ago

yup, I'll get it done by tomorrow! @lwasser

lwasser commented 5 years ago

closing as we have autodoc setup on docstrings. and we can create more specific issues for examples added to the docstrings as need be.