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

Updated docstrings for base module #107

Closed marty-larocque closed 5 years ago

marty-larocque commented 5 years ago

Updated docstrings for the base module.

Here is a pdf of the updated documentation: matplotcheck package — matplotcheck 0.0.10 documentation.pdf

This should resolve issue #102

marty-larocque commented 5 years ago

@lwasser could you take a look at this? Looks like the appveyor test is failing for the same reason as before, but I only changed the comments on one file, so this pull request shouldn't affect testing results anyway. Thanks!

lwasser commented 5 years ago

this is great. If you update from this fork / master branch @ryla5068 it may fix things. when you are working again on this please give this a shot! it seemed to work for me so far but ... let's see!

codecov[bot] commented 5 years ago

Codecov Report

Merging #107 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #107   +/-   ##
=======================================
  Coverage   59.25%   59.25%           
=======================================
  Files          13       13           
  Lines        1205     1205           
=======================================
  Hits          714      714           
  Misses        491      491
Impacted Files Coverage Δ
matplotcheck/base.py 79.23% <ø> (ø) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 89c7bdb...d43c084. Read the comment docs.

lwasser commented 5 years ago

thanks @ryla5068 !! merging this!