Add examples to docstrings about pvlib-python HOT 6 OPEN

@mikofski I support adding brief examples to the function docstrings where they would be useful. Personally, I find documentation pages structured like ModelChain and Clearsky to be more useful, so that's where I've focused my documentation efforts. But I encourage people that want small examples for each function to take on the effort. So I lean toward leaving this generic issue open. What do you think?

from pvlib-python.

can I try to do this sir.

Certainly. Are you somewhat familiar with PV system modeling? That would help with forming examples.

It would be best to take this up in small pieces. Maybe the file iam.py is a place to begin.

from pvlib-python.

We definitely need more examples in the docs. I don't know if we need an example for absolutely everything, though. In any case, we probably will want to change the documentation formatting to 1 page per function.

I don't have any experience using doctest, but I'm ok with trying it out. I would say that we should not rely on doctest for anything other than ensuring that the docs are up to date with the library, and that anything that is in a doctest should be in the main tests.

from pvlib-python.

Any decision on this?

from pvlib-python.

can I try to do this sir.

from pvlib-python.

ok ill start with the iam.py file, thanks for the boost.

from pvlib-python.