Merge pull request 'Update documentation for gender to use GenderEntity in generation of docs' (#10) from docgen-gender-documentation into main
All checks were successful
continuous-integration/drone/push Build is passing

Reviewed-on: #10
This commit is contained in:
Julien Fastré 2024-11-25 17:29:47 +00:00
commit f531de0351

View File

@ -1,4 +1,3 @@
# Génération de documents
L'administrateur fonctionnel prépare la génération des documents.
@ -470,6 +469,12 @@ Seul le champ `comment` est donc disponible.
* `id` (texte): identifiant
* `title` (texte): le titre du résultat
### GenderEntity (Genre)
* `label` (texte): label du genre;
* `id` (int): identifiant (utile pour des comparaisons);
* `genderTranslation` (texte): utilisation grammaticale;
### Household (Ménage)
@ -538,7 +543,7 @@ La composition du ménage entre deux dates. Cette entité associe une `Household
* `birthdate` (Date)
* `age`: (int) age de la personne;
* `deathdate` (Date)
* `gender` (texte): genre (texte traduit);
* `genderEntity` (GenderEntity): Genre;
* `maritalStatus` (texte): représentation textuelle de l'état civil;
* `maritalStatusDate` (Date): date à la quelle le statut de l'état civil a été mis à jour;
* `maritalStatusComment` (Comment): Commentaire sur l'état civil (avec la date de la dernière mise à jour)
@ -553,6 +558,9 @@ La composition du ménage entre deux dates. Cette entité associe une `Household
* `address` (Adresse): l'adresse actuelle
* `resources` (PersonResource): les personnes ressources, ajoutées depuis le dossier de l'usager.
**Note**: La clé `gender` est dépréciée. Merci d'utiliser `GenderEntity`.
#### variant `household`
* `household` (Household): le ménage actuel de l'usager;