POSYDON-code/POSYDON

Reformating and updating all docstrings + adding missing ones.

Aperta

#187 aperta il 8 nov 2023

Vedi su GitHub
 (1 commento) (0 reazioni) (1 assegnatario)Python (35 fork)auto 404
P2 - medium prioritydocumentationenhancementgood first issue

Metriche repository

Star
 (42 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Controlla il formato e la completezza dei docstring di ogni modulo. Usa strumenti come pydocstyle per verificare la formattazione. Aggiorna i parametri e le descrizioni in base all'ultimo codice.
Tech stack
python
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75