codrsquad / codrsquad/portable-python
Request: More detailed documentation about the configuration file
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 86
- Forks
- 13
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
This repository has a very high code quality and very decent output.
I notice this portable-python package is quite configurable, but I can't find any documentation about it, and have to read the source code and test cases. It is not very efficient and a little painful.
Is that possible to add more documentation about portable-python.yaml?
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 le code source et les cas de test qui définissent portable-python.yaml, puis documentez les options de configuration disponibles et leur utilisation. Le travail est terminé lorsque les utilisateurs peuvent comprendre et configurer le paquet sans avoir à consulter le code source ni les tests.
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-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100