[openplacos-dev] Documentation over libification

[flagos <flagospub@xxxxxxxxx>]

Yop le kirsh,

Je mattais un coup d'eil aux commits que tu as liché pour la lib js et
il m'est venu une petite reflexion. J'ai l'impression qu'on prefere
generer des libs remplis de helpers plutot que de fournir de la doc.

L'exemple parfait étant la derniere lib js. Alors, ne le prend pas
pour toi, j'y ai également contribué a ajouter du helper, c'est juste
une réflexion qui m'est venue avec un peu de recul.

En fait, ce qui est criant dans cette lib, c'est qu'on s'amuse a
ajouter des helpers pour accéder aux ressources REST. L'idée de base
de cette lib, c'est de faciliter la vie avec oauth2, surtout que nous
meme on débute avec ce genre de technos. Après, on fournit des
méthodes get et post qui sont vraiment très bien, et qui permettent
l'abstraction de oauth2 tout en conservant la richesse de l'api.
Jusque la, c'est parfait.

Et après, on commence a faire une public api qui restreignent l'accès
aux get et aux post en y calant des valeurs en dur. Je trouve ca
contreproductif. (Encore une fois, j'en ai laché du helper, donc le
prend pas pour toi.) Autant limiter la lib a la gestion de oauth2 et
renvoyer les gonzes a la doc de l'api rest pour savoir où accéder a
quoi. On s'amuse a entretenir une serie de lib, a gerer des
abstractions. C'est un effort de développement non négligeable alors
qu'il suffirait de renvoyer les développeurs vers la description de
l'api rest pour bien faire.

Au niveau des interfaces, on fait beaucoup de libification et peu de
documentation.

Après, c'est pas un mal partout, par exemple les composants: on a
quasiment aucune doc de notre systeme de composants, mais par contre
on a une super lib. Dans ce cas la, je pense qu'on a bien géré le
truc, utiliser la libcomponent est certainement plus simple que de
repartir d'un binding *-dbus et de gerer notre système d'introspect.
Et puis ca permet de gerer le mode thread. Ce n'est clairement pas une
réflexion a sens unique.

T'en dis quoi ?

-- 
Tapé depuis mon clavier