abstract_method_docs.diff

diff -ru lib_old/Lucy/Analysis/CaseFolder.pod lib/Lucy/Analysis/CaseFolder.pod
--- lib_old/Lucy/Analysis/CaseFolder.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Analysis/CaseFolder.pod	2015-09-19 16:52:02.000000000 +0200
@@ -51,6 +51,22 @@
 
 Constructor.  Takes no arguments.
 
+=head1 METHODS
+
+=head2 transform(inversion)
+
+Take a single L<Inversion|Lucy::Analysis::Inversion> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.
+
+=over
+
+=item *
+
+B<inversion> - An inversion.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Analysis::CaseFolder isa L<Lucy::Analysis::Analyzer> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Analysis/EasyAnalyzer.pod lib/Lucy/Analysis/EasyAnalyzer.pod
--- lib_old/Lucy/Analysis/EasyAnalyzer.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Analysis/EasyAnalyzer.pod	2015-09-19 16:52:02.000000000 +0200
@@ -80,6 +80,22 @@
 
 =back
 
+=head1 METHODS
+
+=head2 transform(inversion)
+
+Take a single L<Inversion|Lucy::Analysis::Inversion> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.
+
+=over
+
+=item *
+
+B<inversion> - An inversion.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Analysis::EasyAnalyzer isa L<Lucy::Analysis::Analyzer> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Analysis/Normalizer.pod lib/Lucy/Analysis/Normalizer.pod
--- lib_old/Lucy/Analysis/Normalizer.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Analysis/Normalizer.pod	2015-09-19 16:52:02.000000000 +0200
@@ -72,6 +72,22 @@
 
 =back
 
+=head1 METHODS
+
+=head2 transform(inversion)
+
+Take a single L<Inversion|Lucy::Analysis::Inversion> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.
+
+=over
+
+=item *
+
+B<inversion> - An inversion.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Analysis::Normalizer isa L<Lucy::Analysis::Analyzer> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Analysis/PolyAnalyzer.pod lib/Lucy/Analysis/PolyAnalyzer.pod
--- lib_old/Lucy/Analysis/PolyAnalyzer.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Analysis/PolyAnalyzer.pod	2015-09-19 16:52:02.000000000 +0200
@@ -104,6 +104,20 @@
 
 Getter for “analyzers” member.
 
+=head2 transform(inversion)
+
+Take a single L<Inversion|Lucy::Analysis::Inversion> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.
+
+=over
+
+=item *
+
+B<inversion> - An inversion.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Analysis::PolyAnalyzer isa L<Lucy::Analysis::Analyzer> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Analysis/RegexTokenizer.pod lib/Lucy/Analysis/RegexTokenizer.pod
--- lib_old/Lucy/Analysis/RegexTokenizer.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Analysis/RegexTokenizer.pod	2015-09-19 16:52:02.000000000 +0200
@@ -93,6 +93,22 @@
 
 =back
 
+=head1 METHODS
+
+=head2 transform(inversion)
+
+Take a single L<Inversion|Lucy::Analysis::Inversion> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.
+
+=over
+
+=item *
+
+B<inversion> - An inversion.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Analysis::RegexTokenizer isa L<Lucy::Analysis::Analyzer> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Analysis/SnowballStemmer.pod lib/Lucy/Analysis/SnowballStemmer.pod
--- lib_old/Lucy/Analysis/SnowballStemmer.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Analysis/SnowballStemmer.pod	2015-09-19 16:52:02.000000000 +0200
@@ -61,6 +61,22 @@
 
 =back
 
+=head1 METHODS
+
+=head2 transform(inversion)
+
+Take a single L<Inversion|Lucy::Analysis::Inversion> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.
+
+=over
+
+=item *
+
+B<inversion> - An inversion.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Analysis::SnowballStemmer isa L<Lucy::Analysis::Analyzer> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Analysis/SnowballStopFilter.pod lib/Lucy/Analysis/SnowballStopFilter.pod
--- lib_old/Lucy/Analysis/SnowballStopFilter.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Analysis/SnowballStopFilter.pod	2015-09-19 16:52:02.000000000 +0200
@@ -98,6 +98,22 @@
 
 =back
 
+=head1 METHODS
+
+=head2 transform(inversion)
+
+Take a single L<Inversion|Lucy::Analysis::Inversion> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.
+
+=over
+
+=item *
+
+B<inversion> - An inversion.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Analysis::SnowballStopFilter isa L<Lucy::Analysis::Analyzer> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Analysis/StandardTokenizer.pod lib/Lucy/Analysis/StandardTokenizer.pod
--- lib_old/Lucy/Analysis/StandardTokenizer.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Analysis/StandardTokenizer.pod	2015-09-19 16:52:02.000000000 +0200
@@ -53,6 +53,22 @@
 
 Constructor.  Takes no arguments.
 
+=head1 METHODS
+
+=head2 transform(inversion)
+
+Take a single L<Inversion|Lucy::Analysis::Inversion> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.
+
+=over
+
+=item *
+
+B<inversion> - An inversion.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Analysis::StandardTokenizer isa L<Lucy::Analysis::Analyzer> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Index/DocReader.pod lib/Lucy/Index/DocReader.pod
--- lib_old/Lucy/Index/DocReader.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Index/DocReader.pod	2015-09-19 16:52:02.000000000 +0200
@@ -46,6 +46,25 @@
 
 Returns: a HitDoc.
 
+=head1 METHODS
+
+=head2 aggregator( I<[labeled params]> )
+
+Returns a DocReader which divvies up requests to its sub-readers
+according to the offset range.
+
+=over
+
+=item *
+
+B<readers> - An array of DocReaders.
+
+=item *
+
+B<offsets> - Doc id start offsets for each reader.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Index::DocReader isa L<Lucy::Index::DataReader> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Index/LexiconReader.pod lib/Lucy/Index/LexiconReader.pod
--- lib_old/Lucy/Index/LexiconReader.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Index/LexiconReader.pod	2015-09-19 16:52:02.000000000 +0200
@@ -60,6 +60,25 @@
 
 Return the number of documents where the specified term is present.
 
+=head1 METHODS
+
+=head2 aggregator( I<[labeled params]> )
+
+Return a LexiconReader which merges the output of other
+LexiconReaders.
+
+=over
+
+=item *
+
+B<readers> - An array of LexiconReaders.
+
+=item *
+
+B<offsets> - Doc id start offsets for each reader.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Index::LexiconReader isa L<Lucy::Index::DataReader> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Index/PolyReader.pod lib/Lucy/Index/PolyReader.pod
--- lib_old/Lucy/Index/PolyReader.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Index/PolyReader.pod	2015-09-19 16:52:02.000000000 +0200
@@ -48,6 +48,35 @@
 may be less efficient or complete than the single-segment implementations
 accessed via L<SegReader|Lucy::Index::SegReader>.
 
+=head1 METHODS
+
+=head2 doc_max()
+
+Return the maximum number of documents available to the reader, which
+is also the highest possible internal document id.  Documents which
+have been marked as deleted but not yet purged from the index are
+included in this count.
+
+=head2 doc_count()
+
+Return the number of documents available to the reader, subtracting
+any that are marked as deleted.
+
+=head2 del_count()
+
+Return the number of documents which have been marked as deleted but
+not yet purged from the index.
+
+=head2 _offsets()
+
+Return an array with one entry for each segment, corresponding to
+segment doc_id start offset.
+
+=head2 seg_readers()
+
+Return an array of all the SegReaders represented within the
+IndexReader.
+
 =head1 INHERITANCE
 
 Lucy::Index::PolyReader isa L<Lucy::Index::IndexReader> isa L<Lucy::Index::DataReader> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Index/PostingListReader.pod lib/Lucy/Index/PostingListReader.pod
--- lib_old/Lucy/Index/PostingListReader.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Index/PostingListReader.pod	2015-09-19 16:52:02.000000000 +0200
@@ -61,6 +61,13 @@
 
 =back
 
+=head1 METHODS
+
+=head2 aggregator( I<[labeled params]> )
+
+Returns undef since PostingLists may only be iterated at the
+segment level.
+
 =head1 INHERITANCE
 
 Lucy::Index::PostingListReader isa L<Lucy::Index::DataReader> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Index/Segment.pod lib/Lucy/Index/Segment.pod
--- lib_old/Lucy/Index/Segment.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Index/Segment.pod	2015-09-19 16:52:02.000000000 +0200
@@ -146,6 +146,10 @@
 
 Getter for the object’s document count.
 
+=head2 compare_to(other)
+
+Compare by segment number.
+
 =head1 INHERITANCE
 
 Lucy::Index::Segment isa Clownfish::Obj.
diff -ru lib_old/Lucy/Index/SegReader.pod lib/Lucy/Index/SegReader.pod
--- lib_old/Lucy/Index/SegReader.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Index/SegReader.pod	2015-09-19 16:52:02.000000000 +0200
@@ -65,6 +65,33 @@
 
 Return the number of the segment.
 
+=head2 del_count()
+
+Return the number of documents which have been marked as deleted but
+not yet purged from the index.
+
+=head2 doc_max()
+
+Return the maximum number of documents available to the reader, which
+is also the highest possible internal document id.  Documents which
+have been marked as deleted but not yet purged from the index are
+included in this count.
+
+=head2 doc_count()
+
+Return the number of documents available to the reader, subtracting
+any that are marked as deleted.
+
+=head2 _offsets()
+
+Return an array with one entry for each segment, corresponding to
+segment doc_id start offset.
+
+=head2 seg_readers()
+
+Return an array of all the SegReaders represented within the
+IndexReader.
+
 =head1 INHERITANCE
 
 Lucy::Index::SegReader isa L<Lucy::Index::IndexReader> isa L<Lucy::Index::DataReader> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Index/SegWriter.pod lib/Lucy/Index/SegWriter.pod
--- lib_old/Lucy/Index/SegWriter.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Index/SegWriter.pod	2015-09-19 16:52:02.000000000 +0200
@@ -85,6 +85,29 @@
 the Segment’s internal document id, then calls Add_Inverted_Doc(),
 feeding all sub-writers.
 
+=head2 add_segment( I<[labeled params]> )
+
+Add content from an existing segment into the one currently being
+written.
+
+=over
+
+=item *
+
+B<reader> - The SegReader containing content to add.
+
+=item *
+
+B<doc_map> - An array of integers mapping old document ids to
+new.  Deleted documents are mapped to 0, indicating that they should be
+skipped.
+
+=back
+
+=head2 finish()
+
+Complete the segment: close all streams, store metadata, etc.
+
 =head1 INHERITANCE
 
 Lucy::Index::SegWriter isa L<Lucy::Index::DataWriter> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Object/BitVector.pod lib/Lucy/Object/BitVector.pod
--- lib_old/Lucy/Object/BitVector.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Object/BitVector.pod	2015-09-19 16:52:02.000000000 +0200
@@ -206,6 +206,10 @@
 
 Return an array where each element represents a set bit.
 
+=head2 clone()
+
+Return a clone of the object.
+
 =head1 INHERITANCE
 
 Lucy::Object::BitVector isa Clownfish::Obj.
diff -ru lib_old/Lucy/Search/ANDQuery.pod lib/Lucy/Search/ANDQuery.pod
--- lib_old/Lucy/Search/ANDQuery.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/ANDQuery.pod	2015-09-19 16:52:02.000000000 +0200
@@ -57,6 +57,31 @@
 
 =back
 
+=head1 METHODS
+
+=head2 make_compiler( I<[labeled params]> )
+
+Abstract factory method returning a Compiler derived from this Query.
+
+=over
+
+=item *
+
+B<searcher> - A Searcher.
+
+=item *
+
+B<boost> - A scoring multiplier.
+
+=item *
+
+B<subordinate> - Indicates whether the Query is a subquery (as
+opposed to a top-level query).  If false, the implementation must
+invoke L<normalize()|Lucy::Search::Compiler> on the newly minted Compiler object before returning
+it.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Search::ANDQuery isa L<Lucy::Search::PolyQuery> isa L<Lucy::Search::Query> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Search/Collector/BitCollector.pod lib/Lucy/Search/Collector/BitCollector.pod
--- lib_old/Lucy/Search/Collector/BitCollector.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/Collector/BitCollector.pod	2015-09-19 16:52:02.000000000 +0200
@@ -62,6 +62,12 @@
 
 =back
 
+=head1 METHODS
+
+=head2 collect(doc_id)
+
+Set bit in the object’s BitVector for the supplied doc id.
+
 =head1 INHERITANCE
 
 Lucy::Search::Collector::BitCollector isa L<Lucy::Search::Collector> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Search/IndexSearcher.pod lib/Lucy/Search/IndexSearcher.pod
--- lib_old/Lucy/Search/IndexSearcher.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/IndexSearcher.pod	2015-09-19 16:52:02.000000000 +0200
@@ -66,6 +66,59 @@
 
 =head1 METHODS
 
+=head2 doc_max()
+
+Return the maximum number of docs in the collection represented by the
+Searcher, which is also the highest possible internal doc id.
+Documents which have been marked as deleted but not yet purged are
+included in this count.
+
+=head2 doc_freq( I<[labeled params]> )
+
+Return the number of documents which contain the term in the given
+field.
+
+=over
+
+=item *
+
+B<field> - Field name.
+
+=item *
+
+B<term> - The term to look up.
+
+=back
+
+=head2 collect( I<[labeled params]> )
+
+Iterate over hits, feeding them into a
+L<Collector|Lucy::Search::Collector>.
+
+=over
+
+=item *
+
+B<query> - A Query.
+
+=item *
+
+B<collector> - A Collector.
+
+=back
+
+=head2 fetch_doc(doc_id)
+
+Retrieve a document.  Throws an error if the doc id is out of range.
+
+=over
+
+=item *
+
+B<doc_id> - A document id.
+
+=back
+
 =head2 get_reader()
 
 Accessor for the object’s C<reader> member.
diff -ru lib_old/Lucy/Search/LeafQuery.pod lib/Lucy/Search/LeafQuery.pod
--- lib_old/Lucy/Search/LeafQuery.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/LeafQuery.pod	2015-09-19 16:52:02.000000000 +0200
@@ -85,6 +85,10 @@
 
 Accessor for object’s C<text> attribute.
 
+=head2 make_compiler( I<[labeled params]> )
+
+Throws an error.
+
 =head1 INHERITANCE
 
 Lucy::Search::LeafQuery isa L<Lucy::Search::Query> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Search/MatchAllQuery.pod lib/Lucy/Search/MatchAllQuery.pod
--- lib_old/Lucy/Search/MatchAllQuery.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/MatchAllQuery.pod	2015-09-19 16:52:02.000000000 +0200
@@ -42,6 +42,31 @@
 
 Constructor.  Takes no arguments.
 
+=head1 METHODS
+
+=head2 make_compiler( I<[labeled params]> )
+
+Abstract factory method returning a Compiler derived from this Query.
+
+=over
+
+=item *
+
+B<searcher> - A Searcher.
+
+=item *
+
+B<boost> - A scoring multiplier.
+
+=item *
+
+B<subordinate> - Indicates whether the Query is a subquery (as
+opposed to a top-level query).  If false, the implementation must
+invoke L<normalize()|Lucy::Search::Compiler> on the newly minted Compiler object before returning
+it.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Search::MatchAllQuery isa L<Lucy::Search::Query> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Search/NoMatchQuery.pod lib/Lucy/Search/NoMatchQuery.pod
--- lib_old/Lucy/Search/NoMatchQuery.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/NoMatchQuery.pod	2015-09-19 16:52:02.000000000 +0200
@@ -42,6 +42,31 @@
 
 Constructor. Takes no arguments.
 
+=head1 METHODS
+
+=head2 make_compiler( I<[labeled params]> )
+
+Abstract factory method returning a Compiler derived from this Query.
+
+=over
+
+=item *
+
+B<searcher> - A Searcher.
+
+=item *
+
+B<boost> - A scoring multiplier.
+
+=item *
+
+B<subordinate> - Indicates whether the Query is a subquery (as
+opposed to a top-level query).  If false, the implementation must
+invoke L<normalize()|Lucy::Search::Compiler> on the newly minted Compiler object before returning
+it.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Search::NoMatchQuery isa L<Lucy::Search::Query> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Search/NOTQuery.pod lib/Lucy/Search/NOTQuery.pod
--- lib_old/Lucy/Search/NOTQuery.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/NOTQuery.pod	2015-09-19 16:52:02.000000000 +0200
@@ -74,6 +74,29 @@
 
 Setter for the object’s negated query.
 
+=head2 make_compiler( I<[labeled params]> )
+
+Abstract factory method returning a Compiler derived from this Query.
+
+=over
+
+=item *
+
+B<searcher> - A Searcher.
+
+=item *
+
+B<boost> - A scoring multiplier.
+
+=item *
+
+B<subordinate> - Indicates whether the Query is a subquery (as
+opposed to a top-level query).  If false, the implementation must
+invoke L<normalize()|Lucy::Search::Compiler> on the newly minted Compiler object before returning
+it.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Search::NOTQuery isa L<Lucy::Search::PolyQuery> isa L<Lucy::Search::Query> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Search/ORQuery.pod lib/Lucy/Search/ORQuery.pod
--- lib_old/Lucy/Search/ORQuery.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/ORQuery.pod	2015-09-19 16:52:02.000000000 +0200
@@ -58,6 +58,31 @@
 
 =back
 
+=head1 METHODS
+
+=head2 make_compiler( I<[labeled params]> )
+
+Abstract factory method returning a Compiler derived from this Query.
+
+=over
+
+=item *
+
+B<searcher> - A Searcher.
+
+=item *
+
+B<boost> - A scoring multiplier.
+
+=item *
+
+B<subordinate> - Indicates whether the Query is a subquery (as
+opposed to a top-level query).  If false, the implementation must
+invoke L<normalize()|Lucy::Search::Compiler> on the newly minted Compiler object before returning
+it.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Search::ORQuery isa L<Lucy::Search::PolyQuery> isa L<Lucy::Search::Query> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Search/PhraseQuery.pod lib/Lucy/Search/PhraseQuery.pod
--- lib_old/Lucy/Search/PhraseQuery.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/PhraseQuery.pod	2015-09-19 16:52:02.000000000 +0200
@@ -66,6 +66,29 @@
 
 Accessor for object’s array of terms.
 
+=head2 make_compiler( I<[labeled params]> )
+
+Abstract factory method returning a Compiler derived from this Query.
+
+=over
+
+=item *
+
+B<searcher> - A Searcher.
+
+=item *
+
+B<boost> - A scoring multiplier.
+
+=item *
+
+B<subordinate> - Indicates whether the Query is a subquery (as
+opposed to a top-level query).  If false, the implementation must
+invoke L<normalize()|Lucy::Search::Compiler> on the newly minted Compiler object before returning
+it.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Search::PhraseQuery isa L<Lucy::Search::Query> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Search/PolySearcher.pod lib/Lucy/Search/PolySearcher.pod
--- lib_old/Lucy/Search/PolySearcher.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/PolySearcher.pod	2015-09-19 16:52:02.000000000 +0200
@@ -65,6 +65,61 @@
 
 =back
 
+=head1 METHODS
+
+=head2 doc_max()
+
+Return the maximum number of docs in the collection represented by the
+Searcher, which is also the highest possible internal doc id.
+Documents which have been marked as deleted but not yet purged are
+included in this count.
+
+=head2 doc_freq( I<[labeled params]> )
+
+Return the number of documents which contain the term in the given
+field.
+
+=over
+
+=item *
+
+B<field> - Field name.
+
+=item *
+
+B<term> - The term to look up.
+
+=back
+
+=head2 collect( I<[labeled params]> )
+
+Iterate over hits, feeding them into a
+L<Collector|Lucy::Search::Collector>.
+
+=over
+
+=item *
+
+B<query> - A Query.
+
+=item *
+
+B<collector> - A Collector.
+
+=back
+
+=head2 fetch_doc(doc_id)
+
+Retrieve a document.  Throws an error if the doc id is out of range.
+
+=over
+
+=item *
+
+B<doc_id> - A document id.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Search::PolySearcher isa L<Lucy::Search::Searcher> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Search/RangeQuery.pod lib/Lucy/Search/RangeQuery.pod
--- lib_old/Lucy/Search/RangeQuery.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/RangeQuery.pod	2015-09-19 16:52:02.000000000 +0200
@@ -94,6 +94,31 @@
 
 =back
 
+=head1 METHODS
+
+=head2 make_compiler( I<[labeled params]> )
+
+Abstract factory method returning a Compiler derived from this Query.
+
+=over
+
+=item *
+
+B<searcher> - A Searcher.
+
+=item *
+
+B<boost> - A scoring multiplier.
+
+=item *
+
+B<subordinate> - Indicates whether the Query is a subquery (as
+opposed to a top-level query).  If false, the implementation must
+invoke L<normalize()|Lucy::Search::Compiler> on the newly minted Compiler object before returning
+it.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Search::RangeQuery isa L<Lucy::Search::Query> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Search/RequiredOptionalQuery.pod lib/Lucy/Search/RequiredOptionalQuery.pod
--- lib_old/Lucy/Search/RequiredOptionalQuery.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/RequiredOptionalQuery.pod	2015-09-19 16:52:02.000000000 +0200
@@ -81,6 +81,29 @@
 
 Setter for the optional Query.
 
+=head2 make_compiler( I<[labeled params]> )
+
+Abstract factory method returning a Compiler derived from this Query.
+
+=over
+
+=item *
+
+B<searcher> - A Searcher.
+
+=item *
+
+B<boost> - A scoring multiplier.
+
+=item *
+
+B<subordinate> - Indicates whether the Query is a subquery (as
+opposed to a top-level query).  If false, the implementation must
+invoke L<normalize()|Lucy::Search::Compiler> on the newly minted Compiler object before returning
+it.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Search::RequiredOptionalQuery isa L<Lucy::Search::PolyQuery> isa L<Lucy::Search::Query> isa Clownfish::Obj.
diff -ru lib_old/Lucy/Search/Span.pod lib/Lucy/Search/Span.pod
--- lib_old/Lucy/Search/Span.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/Span.pod	2015-09-19 16:52:02.000000000 +0200
@@ -99,6 +99,23 @@
 
 Setter for C<weight> attribute.
 
+=head2 compare_to(other)
+
+Indicate whether one object is less than, equal to, or greater than
+another.
+
+=over
+
+=item *
+
+B<other> - Another Obj.
+
+=back
+
+Returns: 0 if the objects are equal, a negative number if
+C<self> is less than C<other>, and a positive
+number if C<self> is greater than C<other>.
+
 =head1 INHERITANCE
 
 Lucy::Search::Span isa Clownfish::Obj.
diff -ru lib_old/Lucy/Search/TermQuery.pod lib/Lucy/Search/TermQuery.pod
--- lib_old/Lucy/Search/TermQuery.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/Lucy/Search/TermQuery.pod	2015-09-19 16:52:02.000000000 +0200
@@ -71,6 +71,29 @@
 
 Accessor for object’s C<term> member.
 
+=head2 make_compiler( I<[labeled params]> )
+
+Abstract factory method returning a Compiler derived from this Query.
+
+=over
+
+=item *
+
+B<searcher> - A Searcher.
+
+=item *
+
+B<boost> - A scoring multiplier.
+
+=item *
+
+B<subordinate> - Indicates whether the Query is a subquery (as
+opposed to a top-level query).  If false, the implementation must
+invoke L<normalize()|Lucy::Search::Compiler> on the newly minted Compiler object before returning
+it.
+
+=back
+
 =head1 INHERITANCE
 
 Lucy::Search::TermQuery isa L<Lucy::Search::Query> isa Clownfish::Obj.
diff -ru lib_old/LucyX/Search/ProximityQuery.pod lib/LucyX/Search/ProximityQuery.pod
--- lib_old/LucyX/Search/ProximityQuery.pod	2015-09-19 16:51:19.000000000 +0200
+++ lib/LucyX/Search/ProximityQuery.pod	2015-09-19 16:52:02.000000000 +0200
@@ -71,6 +71,29 @@
 
 Accessor for object’s within attribute.
 
+=head2 make_compiler( I<[labeled params]> )
+
+Abstract factory method returning a Compiler derived from this Query.
+
+=over
+
+=item *
+
+B<searcher> - A Searcher.
+
+=item *
+
+B<boost> - A scoring multiplier.
+
+=item *
+
+B<subordinate> - Indicates whether the Query is a subquery (as
+opposed to a top-level query).  If false, the implementation must
+invoke L<normalize()|Lucy::Search::Compiler> on the newly minted Compiler object before returning
+it.
+
+=back
+
 =head1 INHERITANCE
 
 LucyX::Search::ProximityQuery isa L<Lucy::Search::Query> isa Clownfish::Obj.