apertium / apertium/apertium-python

Cleanup readme and docstrings

Aperta
#20 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
Python
Stelle
35
Fork
27
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

> IMO, it's pretty silly having these docstrings just repeat the type of the argument. Rather, they should describe the argument and then whatever document generation tool we use will automatically insert the type annotations (i.e. Sphinx). Just mentioning it now though. We can deal with it later.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia esaminando il README del repository e le docstring Python, quindi verifica se Sphinx o un altro generatore di documentazione è configurato. Chiarisci quali descrizioni ripetitive dei tipi devono essere modificate e quale output della documentazione è previsto; il lavoro è completato quando il README e le docstring concordati descrivono gli argomenti senza testo ridondante sui tipi.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
20/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.