Re: Re: [PEPr] +1 for Web Services::Services_GeoNames

Michael Gauthier a écrit :

On Wed, 2008-12-10 at 19:43 +0100, Christian Weiske wrote:

Hello David,

Nicely small and clean code. I'd like to see @method tags in the class docblock since you use __call.

I thought about adding the @method tags but imho it would be just duplicating the geonames documentation, and it would be harder to maintain/keep sync with their API, that's why I just put an @link tag pointing to the official documentation.

But IDEs with code completion could at least list the available methods .)

This will also help developers who start by reading API documentation. Without @method tags, they may look at the list of methods and be confused because none of the API appears to be present. Of course, higher-level documentation explaining this (in the package description or peardoc) would help out even more. Cheers, Mike

Done: http://code.google.com/p/services-geonames/source/browse/trunk/Services/GeoNames.php http://code.google.com/p/services-geonames/wiki/GettingStarted http://code.google.com/p/services-geonames/wiki/UsageExamples I'll port the doc to peardoc when I'll have time. -- David