Update docstrings to include more detail

Aperta
#14 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia esaminando le funzioni Python del repository e i docstring esistenti per identificare la copertura mancante e le convenzioni di documentazione del progetto. Aggiorna il docstring di ogni funzione con i relativi parametri e il comportamento restituito, ove applicabile; il lavoro è completato quando ogni funzione dispone di un docstring sufficientemente dettagliato.

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

Descrizione

bug good first issue template

Each function will require a docstring. Existing functions with docstrings currently don't explain what the function should do. Update these to include parameters and return statements where necessary.

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

Guida per i contributori

Apri la guida per i contributori

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 MLH-Fellowship/orientation-project-python

Tutte le issue di MLH-Fellowship/orientation-project-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.