Re: enchant doc, call for review

From: Date: Thu, 10 Aug 2006 22:28:04 +0000
Subject: Re: enchant doc, call for review
References: 1  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969373701@lists.php.net to get a copy of this message
some comments: * we don't use tabs in examples. only spaces (4). we strictly follow the PEAR standards. * we also don't use tabs for indentation * enchant_broker_describe() lacks documentation on some sections * you aren't using the &return.success; entity. it could be used for example in enchant_broker_free() * enchant_dict_check() needs some attention * there is a &example.outputs.similar; entity that should be used for example in enchant_broker_list_dicts(). * strange example in enchant_dict_quick_check(): if (enchant_broker_dict_exists($r,$tag)) { } // nothing to do there? there are also a couple of typos, but we'll squash them later. I think thats all for now :) Thanks, Nuno ----- Original Message -----
Hello, Can someone review the new doc for PECL Enchant before I commit or simply commit it if it looks ok? It passes the test and is generated correctly: http://blog.thepimp.net/misc/zip/enchant_docbook.tgz The docbook is available here (you need to add &url.enchant;[1] to the globals.ent): http://blog.thepimp.net/misc/zip/html/ref.enchant.html Thanks :) Cheers, -- Pierre [1] <!ENTITY url.enchant "http://www.abisource.com/projects/enchant/">


« previous php.doc (#969373701) next »