lincc-frameworks / lincc-frameworks/python-project-template
Nice to have: a page in the PPT docs with basics of OOP, modules, rel imports, etc
Nessuno ha ancora preso questa issue.
- Lingua principale
- Jinja
- Stelle
- 85
- Fork
- 16
- Merge medio
- 6h 18m
- PR unite (30g)
- 1
Descrizione
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando la struttura esistente della documentazione PPT e le pagine rivolte agli utenti di software scientifico. Aggiungi una pagina che tratti la sintassi OOP specifica di Python, i moduli e gli import relativi, con nozioni di base sufficienti ad aiutare i lettori che hanno familiarità con l’OOP in altri ambienti; il lavoro sarà considerato completato quando la pagina sarà integrata nella documentazione e coprirà gli argomenti richiesti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 68/100