Use help parameter for traits rather than setting __doc__

[dopplershift]

Currently all the traits in the simplified plotting interface are documented by setting the __doc__ attribute. Traits have a help parameter in the constructor that we can use instead, and with traitlets 5.8.0, this now maps to the __doc__ attribute.

We should update, though we should check on whether there are other impacts of this beyond just building our docs (e.g. in jupyter environments). If there are jupyter ramifications, we probably want to wait a bit before making 5.8.0 our minimum version.

[mohamed591195]

Hello! I'm interested in contributing to this project, Could you provide some guidance on how to approach this issue, or suggest any resources that could help me get started

[dcamron]

Hi @mohamed591195! Thanks for your interest. Definitely start with the MetPy Contributor's Guide to get set up first. This issue concerns declarative.py and the variety of class parameters we define using the traitlets library. declarative.ArrowPlot.arrowscale is one such Trait, and there are many in the file. You can see how these traits are used in this tutorial on the docs.

All of these traits have docstrings we manually assign to traitlet.__doc__ so that users know the specific behavior of each trait. If we can update this to use the help parameter when we construct our traitlets (see eg this function signature and all others on that page), we might get more compatibility with other tools in the space, and make the docstrings more discoverable and usable by MetPy users.

Some considerations:

• this is only doable with traitlets>=5.8.0, so you'll have to see if enforcing that minimum version in pyproject.toml breaks anything
• changing this parameter might have ramifications on the MetPy documentation, be sure to take a look to see if/how things change
• we rely on some of these docstrings for usability in Jupyter, eg help(), ?, and <Tab> completion. Be sure to explore these and see how behaviors change before and after your change

I hope this is plenty to help you get started, and we look forward to a PR!