lincc-frameworks / lincc-frameworks/python-project-template
Nice to have: a page in the PPT docs with basics of OOP, modules, rel imports, etc
Personne n'a encore pris cette issue.
- Langage dominant
- Jinja
- Étoiles
- 85
- Forks
- 16
- Merge moyen
- 6 h 18 min
- PR mergées (30 j)
- 1
Description
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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner la structure existante de la documentation PPT et les pages destinées aux utilisateurs de logiciels scientifiques. Ajoutez une page couvrant la syntaxe OOP propre à Python, les modules et les imports relatifs, avec suffisamment de notions de base pour aider les lecteurs familiarisés avec l’OOP dans d’autres environnements ; le travail sera considéré comme terminé lorsque la page sera intégrée à la documentation et couvrira les sujets demandés.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- Calme
- Clarté
- Plutôt claire
- Accessibilité débutants
- 68/100