On 09/09/2015 03:30, Marvin Humphrey wrote:
I reviewed a diff of the generated POD before and after merging this branch
(and the corresponding Clownfish branch). A summary of the changes is below my
sig.
Unsurprisingly for a change of this magnitude, there were a few glitches.
These are the ones I think we should to attend to:
* Restore Doc#add_fields.
* IndexReader#offsets became IndexReader#_offsets and should be restored.
These two are glitches.
* Restore documentation for several methods IndexSearcher inherits
from Searcher. Same with PolySearcher (though it's a less important
class).
* The PostingList methods Next, Advance, and Get_Doc_ID should become
public.
* Restore BitCollector#collect
* Restore ANDQuery#add_child and ORQuery#add_child.
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.
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.
Nick
