next-exp/IC

Standardize naming of groups and nodes in output files

Open

#819 aperta il 25 mag 2022

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

Metriche repository

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

Descrizione

So far, we have named the groups and nodes of our output files slightly randomly. I propose that we name them in a standard manner. We can discuss other options, but my preferred one is /data_type/node_name, where

  • data_type can be RWF, PMAPS, KDST, HDST, DDST, etc, and
  • node_name will be something descriptive of what it holds (like S1Pmt for pmaps) or simply data for when there is a single table, and there is no obvious better name for the node.

Of course, this will need to update some of our reader functions so they are backward-compatible, but it might be worth the effort. Thoughts?

Guida contributor

Direzione di ricerca
Discutere le convenzioni di denominazione e implementare modifiche retrocompatibili nelle funzioni di lettura.
Tech stack
python
Dominio
data
Tipo issue
Refactoring
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
Basic knowledge of the project's data types
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70