Documentation des saisies et options qui n'ont pas à être dans le constructeur #90

Open
opened 2 years ago by maieul · 3 comments
maieul commented 2 years ago
Owner

Actuellement la documentation de saisies se fait en partant des constructeurs.

Ca marche bien pour 99% des options. Mais certaines options n'ont pas à être dans un constructeur de formulaire, pour des raisons de sécurité ou de simplicité.

Exemple :

  • id
  • inserer_debut
  • inserer_fin
  • même dans une certaine mesure 'datas' : il faudrait que l'explication soit différentes lorsqu'on a une interface de construction (ou il faut expliquer la syntaxe cle|valeur et dans la doc de saisies (ou là on peut parler de tableau PHP/#ARRAY).

Ma question est donc : comment faire ?

Actuellement la documentation de saisies se fait en partant des constructeurs. Ca marche bien pour 99% des options. Mais certaines options n'ont pas à être dans un constructeur de formulaire, pour des raisons de sécurité ou de simplicité. Exemple : - id - inserer_debut - inserer_fin - même dans une certaine mesure 'datas' : il faudrait que l'explication soit différentes lorsqu'on a une interface de construction (ou il faut expliquer la syntaxe `cle|valeur` et dans la doc de saisies (ou là on peut parler de tableau PHP/#ARRAY). Ma question est donc : comment faire ?
Owner

Peut-être qu'il faut dans ces rares cas une clé dédiée "explication_dev" avec une chaine dédiée, et quand on génère la documentation, si elle existe, on affiche plutôt ça, et sinon l'explication commune. Ce serait un moyen simple de générer la doc de ces quelques cas d'exception et ça sera réutilisable dès qu'on doit avoir une différence entre les devs et l'interface.

Peut-être qu'il faut dans ces rares cas une clé dédiée "explication_dev" avec une chaine dédiée, et quand on génère la documentation, si elle existe, on affiche plutôt ça, et sinon l'explication commune. Ce serait un moyen simple de générer la doc de ces quelques cas d'exception et ça sera réutilisable dès qu'on doit avoir une différence entre les devs et l'interface.
JLuc changed title from Documenttation des saisies et options qui n'ont pas à être dans le constructeur to Documentation des saisies et options qui n'ont pas à être dans le constructeur 1 year ago
JLuc commented 1 year ago
Collaborator

Bonne idée un champ explication_dev. Pour data c'est même assez critique actuellement. Mais plutôt que remplacer l'explication "UI", est ce qu'elle ne doit pas s'ajouter à l'explication "UI" ? Car le dev a souvent intérêt à savoir ce que sait l'utilisateur de formidable ou autre.

Hmm peut être pas car pour data d'une liste de boutons radios j'ai l'impression qu'il y a pas grand chose à garder pour le dev :

« Liste des choix possibles (data)
Vous devez indiquez un choix par ligne sous la forme "cle|Label" du choix.
La clé doit être unique, brève, claire et ne doit plus être modifiée par la suite.
Vous pouvez indiquer le début d’un sous-groupe sous la forme "*Titre du sous-groupe". Pour finir un sous-groupe vous pouvez en entamez un autre, ou bien mettre une ligne contenant uniquement "/*".  »
Bonne idée un champ `explication_dev`. Pour `data` c'est même assez critique actuellement. Mais plutôt que remplacer l'explication "UI", est ce qu'elle ne doit pas s'**ajouter** à l'explication "UI" ? Car le dev a souvent intérêt à savoir ce que sait l'utilisateur de formidable ou autre. Hmm peut être pas car pour `data` d'une liste de boutons radios j'ai l'impression qu'il y a pas grand chose à garder pour le dev : ``` « Liste des choix possibles (data) Vous devez indiquez un choix par ligne sous la forme "cle|Label" du choix. La clé doit être unique, brève, claire et ne doit plus être modifiée par la suite. Vous pouvez indiquer le début d’un sous-groupe sous la forme "*Titre du sous-groupe". Pour finir un sous-groupe vous pouvez en entamez un autre, ou bien mettre une ligne contenant uniquement "/*". » ```
Owner

Oui ok ça pourrait l'ajouter en plus si elle existe, avec préfixé auto en gras "Pour les devs : blablabla".

Oui ok ça pourrait l'ajouter *en plus* si elle existe, avec préfixé auto en gras "**Pour les devs** : blablabla".
rastapopoulos added the
amélioration
label 1 year ago
Sign in to join this conversation.
No Milestone
No Assignees
3 Participants
Notifications
Due Date

No due date set.

Dependencies

This issue currently doesn't have any dependencies.

Loading…
There is no content yet.