Facebook LinkedIn SourceForge Twitter RSS LastFM
logologo

Ma première contribution au manuel PHP

Geoffray Warnants|24/05/2011|38 commentaires

Au cours de mes recherches dans les profondeurs de la documentation PHP, il m'arrive assez fréquemment de rencontrer des anomalies diverses comme des prototypes de fonction incomplets, de grossières fautes d'orthographe ou des phrases à peine plus compréhensibles que celles générées par un traducteur automatique. Autant de détails dont l'importance peut paraître insignifiante mais qui contribuent à décrédibiliser le sérieux du langage. Et pourtant, en ingrat développeur que je suis, j'avoue n'avoir jamais pris la peine d'informer la communauté PHP de ces défauts, sombrant de jours en jours en peu plus loin dans le péché.

Jusqu'au jour où ma bonne conscience se réveilla, probablement illuminée par une intervention de notre bienveillant Dieu Rasmus, qui de tout là-haut ramène ses fidèles développeurs dans le droit chemin. Au cours de cette divine apparition, il me pardonna puis me rappela l'existence de son outil de rapport de bugs et insista sur le fait que les problèmes liés à la documentation y sont bien entendu acceptés, car tout bug est égal à son prochain.

Je me suis donc depuis lors acharné à signaler le moindre problème rencontré, et c'est ainsi plus d'une centaine de corrections qui ont été envoyées, approuvées puis appliquées à notre manuel chéri. Sans vouloir imiter Frédéric Hardy et ses Nouvelles du front, voici l'inventaire des modifications apportées aux prototypes de nombreuses fonctions :

#54747, #54748, #54749, #54750, #54751, #54752, #54753, #54754, #54755, #54756, #54757, #54761, #54762, #54763, #54768, #54770, #54771, #54772, #54773, #54779, #54780, #54781, #54782, #54783, #54784, #54785, #54786, #54787, #54788, #54789, #54790, #54793, #54794, #54795, #54796, #54797, #54800

Celles-ci, plus anecdotiques, concernent essentiellement des corrections orthographiques dans la documentation francophone et des erreurs relevées dans les scripts d'exemple.

#54806, #54807, #54808, #54809, #54810, #54811, #54812, #54813, #54814, #54815, #54816, #54817, #54818, #54819, #54820, #54822, #54823, #54825, #54826, #54827, #54828, #54829, #54830, #54833, #54834, #54835, #54836, #54837, #54838, #54839, #54840, #54841, #54845, #54846, #54847, #54848, #54849, #54850, #54853, #54854, #54855, #54856, #54857, #54858, #54868, #54869, #54872, #54873, #54874, #54875, #54876, #54877, #54878, #54879, #54880, #54881, #54882, #54883, #54884, #54885, #54886, #54887, #54889, #54890, #54891

Une démarche apparemment trop peu fréquente, puisqu'elle a suscité la curiosité de plusieurs membres éminents de la Documentation Team comme Peter Cowburn, Richard Quadling ou Pierrick Charron, visiblement soucieux de mon intégrité humaine. La méthode utilisée ne relève pourtant pas du miracle : j'ai simplement téléchargé le manuel au format HTML, puis à l'aide de quelques expressions régulières j'ai rapidement pu détecter les fautes d'orthographe ou de grammaire courantes. Je ne peux donc qu'encourager chaque développeur à participer, dès qu'il en a l'opportunité, à l'amélioration de ce formidable outil dont nous profitons tous égoïstement. Un simple acte citoyen suffit à témoigner de la reconnaissance envers les nombreux anonymes bénévoles dont les contributions nous furent, un jour ou l'autre, d'une aide plus que précieuse.

<<< Retour

Vos commentaires

10 commentaires postés

Michel Billon
17/04/2022 21:50Posté par Michel Billon
Bonjour Geoffray,

Travaillez vous freelance? J'ai des missions (100% remote et sans horaire fixé) pour vous en javascript & PHP. vous seriez parfait pour le job.

Bien à vous,

Michel
llilia9
09/11/2017 13:16Posté par llilia9
J?ai trouve cet article très intéressant.Merci
étudiante
10/06/2017 08:25Posté par étudiante
Cet article est très intéressant et surtout très enrichissant!
KaRaK
23/04/2013 17:57Posté par KaRaK
La grande classe !
JC
05/11/2012 23:09Posté par JC
Bonsoir,

Merci votre blog est formidable....

Cordialement
Yannick
17/09/2011 11:46Posté par Yannick
... comme, entre autres, l'espagnol et le russe !

Bref. Tout cela pour dire que le début du billet est un peu aride, mais que nous apprécions ton travail ;)
Yannick
17/09/2011 11:14Posté par Yannick
Pour rappel, la documentation PHP, c'est plus de 10 000 fichiers XML. La documentation française est la traduction la plus a jour parmi toutes celles que compte le manuel. Outre les "fautes d'orthographe grossières", outre les traductions "a peine plus compréhensibles que celles issues Dun traducteur automatique", il y a aussi de simples fautes de frappe effectuées par des bénévoles qui passent un temps précieux a contribuer du mieux possible.

Et pour rappel, l'outil permettant d'editer en ligne la documentation Php est d'origine française (cocorico) et a permi un expansion de plusieurs langages ces derniers mois
thedotwriter
01/09/2011 14:09Posté par thedotwriter
C'est beau :')
Continue comme ça, si ça se trouve une de tes corrections m'a servie dans le passé !

Bravo à toi !
warnants olivier
08/06/2011 14:30Posté par warnants olivier
je ne comprend rien a tout sa mais je suis fiere de toi
syndrael
25/05/2011 14:31Posté par syndrael
Félicitation.. c'est bien de s'impliquer comme ça.
Pour ma part, j'ai hélas trop peu de temps pour cela mais je le fais pour certains éditeurs. Je recommande pour la création de workflow ProcessMaker. Je suis dans le top 5 des découvreurs de bugs..LOL !!
S.

Réagir à cet article

*


(Ne sera pas publiée, servira uniquement à afficher votre gravatar)


(Lien en dur et dofollow)

zend framework