next-exp/IC

Standardize naming of groups and nodes in output files

Open

#819 ouverte le 25 mai 2022

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

Métriques du dépôt

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

Description

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?

Guide contributeur

Direction de recherche
Discutez des conventions de nommage et implémentez des modifications rétrocompatibles dans les fonctions de lecture.
Stack technique
python
Domaine
data
Type d'issue
Refactorisation
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
Basic knowledge of the project's data types
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70