next-exp/IC

Standardize naming of groups and nodes in output files

Open

#819 aberto em 25 de mai. de 2022

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Python (77 forks)auto 404
good first issue

Métricas do repositório

Stars
 (10 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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?

Guia do colaborador

Direção de pesquisa
Discuta as convenções de nomenclatura e implemente alterações compatíveis com versões anteriores nas funções de leitura.
Pilha de tecnologia
python
Domain
data
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Basic knowledge of the project's data types
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70