Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convention de nommage #8

Open
streino opened this issue Oct 17, 2024 · 5 comments
Open

Convention de nommage #8

streino opened this issue Oct 17, 2024 · 5 comments

Comments

@streino
Copy link
Contributor

streino commented Oct 17, 2024

Un peu paumé dans la convention de nommage. Je lis ici "score de avg_quality" au lieu de "moyenne de quality->score".
Au minimum, avg__quality__score ?

Originally posted by @streino in #7 (comment)

Mais j'ai l'impression qu'on ferait mieux d'utiliser la sémantique suivante :

  • -> devient _. Seul hic, pas de distinction entre quality->score et un champ dont le nom d'origine serait quality_score. Mais IMO si on est confronté à ce problème le nommage original est pourri.
  • __ utilisé pour séparer le nom du champ du "type" de calcul appliqué sur ce champ.
  • Post-fixer le nom du champ par le type de calcul, pour regrouper lexicalement toutes les infos disponibles sur un champ.

Ce qui donnerait : nom_de_champ__calcul.
Ex : quality_score__mean, contact_point_name__exists, ...

@abulte
Copy link
Contributor

abulte commented Oct 18, 2024

J'aime quand même bien l'idée d'avoir l'info qu'on a été chercher la valeur dans un JSON nested.

Claude propose nom_de_champ__sous_champ__calcul.

@streino
Copy link
Contributor Author

streino commented Oct 18, 2024

J'aime quand même bien l'idée d'avoir l'info qu'on a été chercher la valeur dans un JSON nested.

Claude propose nom_de_champ__sous_champ__calcul.

Il a pas osé le triple underscore ? 😅

Ça me pose pas particulièrement de problème, mais en quoi ça serait utile de savoir qu'on l'a récupéré dans un champ json plutôt qu'un autre champ ? Savoir où chercher dans le modèle data.gouv (mouaif, y a pas tant de nesting) ? Autre chose ?

@abulte
Copy link
Contributor

abulte commented Oct 18, 2024

Yes faire le lien avec le modèle data.gouv.fr sans avoir à trop réfléchir. C'est peut-être pas indispensable mais je trouve ça confortable.

@streino
Copy link
Contributor Author

streino commented Oct 18, 2024

Ok, on part là dessus alors !
Reste à gérer la migration en essayant de conserver l'historique des métriques.

streino added a commit that referenced this issue Oct 18, 2024
Previously was "has_", will be standardised in #8.
@DanFluture275 DanFluture275 moved this to 📋 Backlog Ready in Ecosphères Jan 15, 2025
@DanFluture275
Copy link

Changements à reporter sur le dashboard également

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📋 Backlog Ready
Development

No branches or pull requests

3 participants