POSYDON-code/POSYDON

Reformating and updating all docstrings + adding missing ones.

Ouverte

#187 ouverte le 8 nov. 2023

Voir sur GitHub
 (1 commentaire) (0 réaction) (1 personne assignée)Python (35 forks)auto 404
P2 - medium prioritydocumentationenhancementgood first issue

Métriques du dépôt

Stars
 (42 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

With the automatic creation of the reference from the docstrings we need to check them:

  • check format:
    • here I already checked the format of citations
    • mainly checking the correct indentation, missing black lines, and other warnings and errors
  • update information, e.g. some have more parameters then explained, or some contain outdated information or the information is too much/less detailed
  • add missing ones

Guide contributeur

Direction de recherche
Vérifiez le format et l'exhaustivité des docstrings de chaque module. Utilisez des outils comme pydocstyle pour vérifier le formatage. Mettez à jour les paramètres et les descriptions en fonction du code le plus récent.
Stack technique
python
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75