Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Rewrite docstrings to match scikit-learn Style

Aperta
#491 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
28/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python, scikit-learn
Ambito
documentation

Direzione di ricerca

Non vengono indicati file o test. Inizia individuando i docstring Python del progetto e confrontandoli con l’esempio scikit-learn collegato, inclusi gli spazi dei parametri, i valori predefiniti e le forme degli array NumPy; il lavoro è completato quando i docstring pertinenti seguono sistematicamente quello stile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation enhancement help wanted

We should try and match the way that scikit-learn writes their docstrings. Here 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.

Lingua principale
Python
Stelle
71
Fork
21
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di EducationalTestingService/rsmtool

Tutte le issue di EducationalTestingService/rsmtool

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.