lucy-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Nick Wellnhofer <wellnho...@aevum.de>
Subject Re: [lucy-dev] [GitHub] lucy pull request: Generate Perl POD from public methods
Date Sat, 19 Sep 2015 15:10:47 GMT
On 09/09/2015 18:57, Nick Wellnhofer wrote:
> These are all methods that *are* documented in a parent class. We should
> automatically document them in a subclass if they're the first implementation
> of an abstract method.

I committed the change to create POD for the first implementation of an 
abstract method. This adds quite a few methods to the Perl documentation but I 
think it's the right thing to do:

     https://gist.github.com/nwellnhof/a1cb1b0d62f92d2d3fee

Otherwise it's impossible to tell from the documentation whether a class 
implements an abstract method or not.

> This leaves:
>
> - IndexSearcher#hits, IndexSearcher#get_schema, documented in
>    Lucy::Search::Searcher
>    https://metacpan.org/pod/Lucy::Search::Searcher
> - PostingList#advance, documented in Lucy::Search:Matcher
>    https://metacpan.org/pod/Lucy::Search::Matcher
> - ANDQuery#add_child, ORQuery#add_child, documented in
>    Lucy::Search::PolyQuery (not in 0.4 but in master)
>
> We could document these methods a second time in a subclass but it would be
> somewhat inconsistent.

I'm not sure whether POD for these methods should be added manually.

Nick


Mime
View raw message