Added docstrings to AIPlugIn

[asgibson]

Here is an update for ai_plugin.py using Google style docstrings. Also using type annotations.

Is this the style we'd like to go forward with?
There are other style choices we could choose. i.e., NumPy, reST, or Epytext (others?)

Opinions?

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (822cd97) 100.00% compared to head (4430d0f) 100.00%.

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #98   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           25        25           
  Lines          938       937    -1     
  Branches       129       129           
=========================================
- Hits           938       937    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[the-other-james]

I don't have a strong preference for the comment style we use. If I had to pick, I would go with whatever the python libraries use.

[asgibson]

We have decided to follow numpydoc style:
https://numpydoc.readthedocs.io/en/latest/format.html

[dragonejt]

Hello, I've been browsing the other PR's and issues in the repository. I just wanted to note that since you all have decided on a docstring style to move forward with, most IDEs now have support for automatically generating docstring formats/templates for you to fill in. Essentially, all you will have to do is type """ and press enter, and a docstring template will be generated based on your function parameters and return values. This will save you a lot of time vs typing out the docstrings in full by yourself.

In VSCode, you can use the autoDocstring extension, which has support for numpydoc.

PyCharm already has automatic docstring templates builtin, and already supports numpydoc.

[asgibson]

@dragonejt, thank you for the tool suggestions. As long as people follow the NumPy docstring formatting, they can use whatever tool they want to create them.