26 juillet 2007

Documentation

Faire la doc d'un logiciel est parfois un peu fastidieux. C'est pourquoi certains la pimentent un peu histoire de détendre les lecteurs.

Par exemple, on trouve cette notice à la fin de la man page de tar :


The GNU folks, in general, abhor man pages, and create info documents instead. The maintainer of tar falls into this category. This man page is neither complete, nor current, and was included in the Debian Linux packaging of tar entirely to reduce the frequency with which the lack of a man page gets reported as a bug in our defect tracking system.

If you really want to understand tar, then you should run info and read the tar info pages, or use the info mode in emacs.

Pour faire vite ça veut dire :
Nous on voulait pas la faire cette doc, mais on arrêtait pas de nous saoûler pour la faire. Y'en a déjà une autre qui est bien mieux, alors allez la voir si vous voulez de vraies informations.

Dans un autre registre, on a cet exemple dans la documentation de la fontion str_replace de php :
// Provides: You should eat pizza, beer, and ice cream every day
$phrase = "You should eat fruits, vegetables, and fiber every day.";
$healthy = array("fruits", "vegetables", "fiber");
$yummy = array("pizza", "beer", "ice cream");

$newphrase = str_replace($healthy, $yummy, $phrase);

Ça montre comment transformer la phrase "You should eat fruits, vegetables, and fiber every day." en "You should eat pizza, beer, and ice cream every day." (les trois aliments de base du geek).

Aucun commentaire: