You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Some of our plotting functions have a large amount of kwargs, we could probably use some more documentation of these. Not completely certain of how these are normally documented but here are some posts to get started, seems like we can either add another section under returns, or under parameters (that might work with sphinx)
The text was updated successfully, but these errors were encountered:
Documents kwargs for plotting functions and adds sensible kwargs to those that were lacking them (such as figsize)
- Document kwargs, according to [matplotlib-style documentation](https://stackoverflow.com/questions/62511086/how-to-document-kwargs-according-to-numpy-style-docstring)
- add kwargs to plotting functions missing sensible/useful kwargs
- add check for unused kwargs to most plotting functions
- add plot comparisons to artifact uploaded to github
- bump `pytest-mpl` version to fix [bug](matplotlib/pytest-mpl#171) where if `unittest.TestCase` is used, it did not actually run those tests correctly
resolves#178 , #244
Some of our plotting functions have a large amount of kwargs, we could probably use some more documentation of these. Not completely certain of how these are normally documented but here are some posts to get started, seems like we can either add another section under returns, or under parameters (that might work with sphinx)
The text was updated successfully, but these errors were encountered: