feat: refactor datapackage for etalab spec#10
Conversation
ttdm
changed the title
Pierlou
left a comment
Pierlou
left a comment
There was a problem hiding this comment.
Merci pour le refactor, comme indiqué il n'y a pas besoin de mettre les champs du schéma dans le README, juste la doc explicative du schéma (contexte, définitions...)
|
|
||
| > 📖 **À propos** — Ce schéma fait partie d'un ensemble de schémas décrivant les dispositifs d'aides selon leur cible et pour différents usages. Pour le contexte et la finalité de l'ensemble, consultez la documentation principale. | ||
|
|
||
| ## Champs (26) |
There was a problem hiding this comment.
schema.data.gouv génère une page de documentation à partir du schema.json, pas besoin de mettre la liste des champs dans le README. Le README est affiché dans l'onglet Informations, la documentation (automatique) est dans l'onglet Documentation
There was a problem hiding this comment.
@Pierlou
Pour être clair, quel format préfères tu :
- une simple suppression de la table des champs sur les readme actuels (ça créée des readme très courts qui référencent le readme principal).
- la copie du readme principal sous la section composition même si le contenu, à l'exception de ce paragraphe composition, fait vraiment doublon comme ça peut être le cas su rle repo que tu m'as donné en exemple ?
There was a problem hiding this comment.
Idéalement chaque schéma a un README unique qui reprend potentiellement des passages du README principal en y ajoutant les spécificités du schéma dont il est question (j'imagine que fournir un README entièrement custom dans le contexte est complexe)
| self.assertTrue((schema_dir / "exemple.csv").exists(), f"{name}/exemple.csv") | ||
|
|
||
|
|
||
| class ToTableSchemaTitlingTest(unittest.TestCase): |
David-Guillot
left a comment
David-Guillot
left a comment
There was a problem hiding this comment.
Bravo @ttdm pour cette adaptation rapide ! Je suis pour merger et publier notre 0.2.0 même s'il reste des imperfections de contenu, on aura tout le temps de faire évoluer des détails de la doc quand on aura commencé à publier des données et recueilli des retours de gens qui essayent de s'en servir.
|
C'est tout bon @Pierlou ! J'ai mis à jour la génération du readme. La première section du readme est composé d'infos spécifiques au schéma généré. J'ai fait le choix de raise une erreur si les sections sont renommées dans le readme mais pas dans la constante qui sert à sélectionner les sections intéressantes. |
3 participants
Note : La grande majorité des changements sont sur les fixtures.
TODO : Ajouter le tag v0.2.0 post merge.