apertium / apertium/apertium-python

Cleanup readme and docstrings

Offen
#20 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement
Vorherrschende Sprache
Python
Sterne
35
Forks
27
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

> 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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne mit der Durchsicht der README und der Python-Dokumentstrings und prüfe anschließend, ob Sphinx oder ein anderer Dokumentationsgenerator konfiguriert ist. Kläre, welche sich wiederholenden Typbeschreibungen geändert werden sollten und welche Dokumentationsausgabe erwartet wird; die Arbeit ist abgeschlossen, wenn die abgestimmte README und die Docstrings Argumente ohne redundanten Typtext beschreiben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
20/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.