EducationalTestingService / EducationalTestingService/rsmtool
Rewrite docstrings to match scikit-learn Style
- Vorherrschende Sprache
- Python
- Sterne
- 71
- Forks
- 21
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Es werden keine Dateien oder Tests genannt. Beginne damit, die Python-Docstrings des Projekts zu finden und sie mit dem verlinkten scikit-learn-Beispiel zu vergleichen, einschließlich der Abstände bei Parametern, der Standardwerte und der NumPy-Array-Formen; abgeschlossen ist die Aufgabe, wenn die relevanten Docstrings diesem Stil durchgehend folgen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python, scikit-learn
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 28/100