lincc-frameworks / lincc-frameworks/python-project-template
Nice to have: a page in the PPT docs with basics of OOP, modules, rel imports, etc
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Jinja
- Sterne
- 85
- Forks
- 16
- Ø Merge
- 6 Std. 18 Min.
- Gemergte PRs (30 T.)
- 1
Beschreibung
Inspired by incubee. I think this would be nice for other scientists too, or even anyone used to OOP but not 100% familiar with Python-specific syntax.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
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 bestehende Struktur der PPT-Dokumentation und die Seiten für Nutzer wissenschaftlicher Software zu prüfen. Füge eine Seite hinzu, die Python-spezifische OOP-Syntax, Module und relative Importe behandelt, mit genügend Grundlagen, um Lesern zu helfen, die mit OOP in anderen Umgebungen vertraut sind; als erledigt gilt die Aufgabe, wenn die Seite in die Dokumentation integriert ist und die angeforderten Themen abdeckt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 68/100