dwavesystems / dwavesystems/docs
Add diagram showing relationships between Ocean modules/classes
Offen
- Vorherrschende Sprache
- Python
- Sterne
- 49
- Forks
- 28
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
@spreinhardt 12:31 PM
Is there a diagram somewhere that shows how the different modules within Ocean are nested/layered on each other? And similarly for Classes, which ones are subclasses of others?
Beitragsleitfaden
Rechercherichtung
Es wird keine Datei, kein Test und kein Einstiegspunkt genannt. Beginne damit, die Dokumentation von Ocean sowie seine Modul- und Klassenstruktur zu überprüfen, und erstelle anschließend Diagramme, die die Schichtung der Module und die Klassenvererbung darstellen; abgeschlossen ist die Aufgabe, wenn beide Beziehungsansichten in der Dokumentation veröffentlicht sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 30/100