gridstatus icon indicating copy to clipboard operation
gridstatus copied to clipboard

Improve doc strings

Open kmax12 opened this issue 3 years ago • 0 comments

Now that the new docs are up, it makes sense to go through and clean up the doc strings for all the methods.

Notes:

  • Can we document methods on the base class and have the doc strings show up for subclasses in sphinx?
  • Can we add usage examples in doc string i.e doctest?
  • How can we document methods on subclass that are not defined?

kmax12 avatar Oct 27 '22 16:10 kmax12