ProgLearn icon indicating copy to clipboard operation
ProgLearn copied to clipboard

Published 20 hours ago • verified publisher icon neurodata

document code according to sklearn guidelines

Open jovo opened this issue 4 years ago • 9 comments

jovo avatar Jun 05 '20 20:06 jovo

Can part of this issue be assigned to me?

bstraus1 avatar Sep 02 '20 17:09 bstraus1

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

jovo avatar Sep 02 '20 17:09 jovo

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?

bstraus1 avatar Sep 06 '20 20:09 bstraus1

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

jdey4 avatar Sep 06 '20 23:09 jdey4

@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.

bstraus1 avatar Sep 07 '20 00:09 bstraus1

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

jdey4 avatar Sep 07 '20 22:09 jdey4

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 avatar Sep 07 '20 22:09 bstraus1

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

bstraus1 avatar Sep 09 '20 16:09 bstraus1

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

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

levinwil avatar Oct 17 '20 03:10 levinwil