EducationalTestingService / EducationalTestingService/rsmtool

Rewrite docstrings to match scikit-learn Style

Aperta
#491 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
documentation enhancement help wanted
Lingua principale
Python
Stelle
71
Fork
21
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

We should try and match the way that scikit-learn writes their docstrings. [Here](https://github.com/scikit-learn/scikit-learn/blob/master/sklearn/linear_model/_huber.py#L125) is an example.

For example, there is a blank line between the parameters and the default values are indicated right after the parameter type. It's also nice how the types that are numpy arrays also include the shapes.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.