resgroup/wind-up

allow more config to be unspecified in yaml

Open

#68 aperta il 18 set 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (11 fork)auto 404
good first issue

Metriche repository

Star
 (28 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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)

Guida contributor

Direzione di ricerca
Individua il modello di configurazione pydantic nella codebase. Identifica i tre campi: years offset for pre period, ws bin width, years for detrend. Modifica il modello per renderli opzionali (tipo Optional) e imposta i valori predefiniti (1, 1, 3 rispettivamente). Aggiorna eventuali test che dipendono dal fatto che questi campi siano obbligatori.
Tech stack
python
Dominio
clidata
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80