POSYDON-code/POSYDON

Reformating and updating all docstrings + adding missing ones.

Offen

#187 geöffnet am 08.11.2023

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (1 zugewiesene Person)Python (35 Forks)auto 404
P2 - medium prioritydocumentationenhancementgood first issue

Repository-Metriken

Stars
 (42 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfen Sie die Docstrings jedes Moduls auf Format und Vollständigkeit. Verwenden Sie Tools wie pydocstyle, um die Formatierung zu prüfen. Aktualisieren Sie Parameter und Beschreibungen gemäß dem neuesten Code.
Tech Stack
python
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75