GeographicPlotDisplay documentation missing description of return value

ARM-DOE / ACT

Atmospheric data Community Toolkit - A python based toolkit for exploring and analyzing time series atmospheric datasets

https://ARM-DOE.github.io/ACT/

Other

138 stars 35 forks source link

GeographicPlotDisplay documentation missing description of return value #833

Closed rcjackson closed 4 months ago

rcjackson commented 4 months ago

ACT version: 2.1.1
Python version: all
Operating System: all

Description

The GeographicPlotDisplay is missing a description of the returned matplotlib axes object. This proved to be a bit confusing on how to tell a student how to adjust the axes limits on the GeographicPlotDisplay, since doing so depends on calling the methods of the returned matplotlib axes object.

zssherman commented 4 months ago

@rcjackson Thanks for the heads up, I will work on a change for it! Wait nevermind I see you self assigned

rcjackson commented 4 months ago

@zssherman feel free to work on the quick fix if you have time

zssherman commented 4 months ago

@rcjackson I do, will work on that now!

zssherman commented 4 months ago

@rcjackson For clarification, so a return doc statement for the class itself or one of the plotting functions is missing it? Most of our classes in Py-ART and ACT don't have return docs, so trying to understand

zssherman commented 4 months ago

I do see geoplot is missing a return