Documenter l'API de parenté #4899

Open
opened 1 week ago by tcharlss · 2 comments
tcharlss commented 1 week ago
Owner

Si on ne suit pas assidûment les commits et les PRs, cette API reste bien mystérieuse :)
Bref, il faudrait la documenter sur programmer.

Plan possible pour l'article :

  • But, utilité et périmètre de l'API
  • Méthode pour déclarer les parents d'un type d'objet, avec des exemples (du plus simple au plus complexe)
  • Fonctions pour lister les parents/enfants d'un objet
  • Différences éventuelles avec le plugin ?

Sources :

Si on ne suit pas assidûment les commits et les PRs, cette API reste bien mystérieuse :) Bref, il faudrait la documenter sur programmer. Plan possible pour l'article : * But, utilité et périmètre de l'API * Méthode pour déclarer les parents d'un type d'objet, avec des exemples (du plus simple au plus complexe) * Fonctions pour lister les parents/enfants d'un objet * Différences éventuelles avec le plugin ? Sources : * Exemples de cas simples et fonctions dans [base/objets.php](https://git.spip.net/spip/spip/src/branch/master/ecrire/base/objets.php) * Discussion de la PR !71
tcharlss added the
amélioration
label 1 week ago
Owner

Oui des exemples courants, comme par ex "générer un chemin hiérarchique sur la page d'un contenu"… AH MINCE nan, on sait pas comment faire maintenant que ça peut retourner plusieurs parents… :p

Oui des exemples courants, comme par ex "générer un chemin hiérarchique sur la page d'un contenu"… AH MINCE nan, on sait pas comment faire maintenant que ça peut retourner plusieurs parents… :p
Poster
Owner

Alors je sais plus trop où on en était sur la question, ça avait été mis de côté c'est ça ? (le fait de pouvoir déclarer et identifier un parent "principal").
Pas dans l'API du core et relégué au plugin ?
Faudrait que je relise la discussion.

Mais bref, quoiqu'il en soit il faut commencer à documenter ce qui a été implémenté là pour l'instant. Sans polémique :p

Alors je sais plus trop où on en était sur la question, ça avait été mis de côté c'est ça ? (le fait de pouvoir déclarer et identifier un parent "principal"). Pas dans l'API du core et relégué au plugin ? Faudrait que je relise la discussion. Mais bref, quoiqu'il en soit il faut commencer à documenter ce qui a été implémenté là pour l'instant. Sans polémique :p
b_b added the
documentation
label 7 days ago
b_b added this to the 4.0 milestone 7 days ago
Sign in to join this conversation.
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date

No due date set.

Dependencies

This issue currently doesn't have any dependencies.

Loading…
There is no content yet.