[mkdocs] Improve descriptions
Offen
Dieses Issue hat noch niemand übernommen.
documentation
P2
- Vorherrschende Sprache
- Python
- Sterne
- 18.8k
- Forks
- 2.8k
- Ø Merge
- 16 Std. 26 Min.
- Gemergte PRs (30 T.)
- 21
Beschreibung
Looking at https://github.com/daexs/plotly.py/pull/80/files, some of the descriptions are very short and not informative.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die im referenzierten Pull Request gezeigten Änderungen an Dateien und Beschreibungen zu überprüfen. Identifiziere die Beschreibungen, die zu kurz oder nicht aussagekräftig sind, und aktualisiere sie anschließend, damit die betroffene Dokumentation klarer wird; als erledigt gilt die Aufgabe, wenn die relevanten Beschreibungen nützlichen Kontext ohne unnötige Kürze bieten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100