document code according to sklearn guidelines

[jovo]

No description provided.

[bstraus1]

Can part of this issue be assigned to me?

[jovo]

done, choose your part, and make a new issue, and reference this issue in it.

[bstraus1]

Clarification needed: does this issue refer to commenting and adding variable/function descriptions for network.py and forest.py OR adding the overview/documentation sections on the landing page of the repository?

[jdey4]

Follow the guideline here: https://numpy.org/doc/

[bstraus1]

@jdey4 Two things:
(1) Can you elaborate on which guideline you're referring to at that link?
(2) I'd like to know whether this issue refers to commenting and adding variable/function descriptions for network.py and forest.py OR adding the overview/documentation sections on the landing page of the repository.

[jdey4]

If that thing doesn't help, look at this repo how it handled the docs: https://github.com/neurodata/graspy

[bstraus1]

Okay, cool. And as for documenting forest.py and network.py directly, does commenting like I have begun doing in my fork seem right?

https://github.com/bstraus1/progressive-learning

[bstraus1]

Issue #94 is more accurately the portion of this issue that I will be completing. I've removed myself from this issue.

[levinwil]

https://scikit-learn.org/stable/developers/contributing.html#documentation

1. Add "see also" sections
2. Specify array shapes and types