pypsa-meets-earth/pypsa-earth

Missing config tables and docstrings for some scripts

Aperta

#573 aperta il 22 gen 2023

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Python (349 fork)auto 404
documentationgood first issuehelp wanted

Metriche repository

Star
 (351 stelle)
Metriche merge PR
 (Merge medio 28g 15h) (35 PR mergiate in 30 g)

Descrizione

Describe the feature you'd like to see

The configtables for several pypsa-earth-related scripts are missing. A non-exhaustive list is the following:

  • download_osm_data docstring&configtables
  • clean_osm_data docstring&configtables
  • build_shapes docstring&configtables
  • build_osm_network docstring&configtables
  • base_network only configtables
  • "load_options"; need for creating the build_demand and move the option as well accordingly

Guida contributor

Direzione di ricerca
Guarda gli script esistenti per comprendere il modello di docstring e tabelle di configurazione, quindi applicalo agli script elencati.
Tech stack
python
Dominio
backenddocumentation
Tipo issue
Documentazione
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.
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.
70