testcontainers / testcontainers/testcontainers-python
Docs: add doctests to mkdocs
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 2.3k
- Forks
- 386
- Ø Merge
- 4 Std. 40 Min.
- Gemergte PRs (30 T.)
- 1
Beschreibung
high priority!
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 MkDocs-Konfiguration des Repositorys und die vorhandene Python-Dokumentation zu überprüfen, um festzustellen, welche Beispiele in den Umfang fallen. Führe die in der Dokumentation des Projekts beschriebenen Dokumentations- oder Testbefehle aus, und betrachte die Arbeit als abgeschlossen, wenn die ausgewählten Beispiele unter MkDocs erfolgreich als Doctests ausgeführt werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100