resgroup/wind-up

allow more config to be unspecified in yaml

Open

#68 ouverte le 18 sept. 2025

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Python (11 forks)auto 404
good first issue

Métriques du dépôt

Stars
 (28 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

I was setting up a northing analysis today and tried to run with a yaml missing the below three settings, thinking they would just use suitable defaults. The analysis failed with a pydantic validation error unless these settings were populated in my yaml. It would be nice to not have to specify these in every yaml because they are rarely set to a non-default value.

  • years_offset_for_pre_period (default should be 1)
  • ws_bin_width (default should be 1)
  • years_for_detrend (default should be 3)

Guide contributeur

Direction de recherche
Localisez le modèle de configuration pydantic dans la base de code. Identifiez les trois champs : years offset for pre period, ws bin width, years for detrend. Modifiez le modèle pour les rendre optionnels (type Optional) et définissez leurs valeurs par défaut (1, 1, 3 respectivement). Mettez à jour les tests qui dépendent de ces champs obligatoires.
Stack technique
python
Domaine
clidata
Type d'issue
Fonctionnalité
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.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80