You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by nw...@apache.org on 2016/02/27 16:04:45 UTC
svn commit: r1732649 - in /lucy/site/trunk/content/docs/test: Lucy/
Lucy/Analysis/ Lucy/Document/ Lucy/Highlight/ Lucy/Index/ Lucy/Object/
Lucy/Plan/ Lucy/Search/ Lucy/Store/ LucyX/Search/
Author: nwellnhof
Date: Sat Feb 27 15:04:44 2016
New Revision: 1732649
URL: http://svn.apache.org/viewvc?rev=1732649&view=rev
Log:
Regenerate mdtext of Perl documentation
Modified:
lucy/site/trunk/content/docs/test/Lucy/Analysis/Analyzer.mdtext
lucy/site/trunk/content/docs/test/Lucy/Analysis/CaseFolder.mdtext
lucy/site/trunk/content/docs/test/Lucy/Analysis/EasyAnalyzer.mdtext
lucy/site/trunk/content/docs/test/Lucy/Analysis/Inversion.mdtext
lucy/site/trunk/content/docs/test/Lucy/Analysis/Normalizer.mdtext
lucy/site/trunk/content/docs/test/Lucy/Analysis/PolyAnalyzer.mdtext
lucy/site/trunk/content/docs/test/Lucy/Analysis/RegexTokenizer.mdtext
lucy/site/trunk/content/docs/test/Lucy/Analysis/SnowballStemmer.mdtext
lucy/site/trunk/content/docs/test/Lucy/Analysis/SnowballStopFilter.mdtext
lucy/site/trunk/content/docs/test/Lucy/Analysis/StandardTokenizer.mdtext
lucy/site/trunk/content/docs/test/Lucy/Analysis/Token.mdtext
lucy/site/trunk/content/docs/test/Lucy/Document/Doc.mdtext
lucy/site/trunk/content/docs/test/Lucy/Document/HitDoc.mdtext
lucy/site/trunk/content/docs/test/Lucy/Highlight/Highlighter.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/DataReader.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/DataWriter.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/DeletionsWriter.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/DocReader.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/IndexManager.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/IndexReader.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/Indexer.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/Lexicon.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/LexiconReader.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/PolyReader.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/PostingList.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/PostingListReader.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/SegReader.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/SegWriter.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/Segment.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/Similarity.mdtext
lucy/site/trunk/content/docs/test/Lucy/Index/Snapshot.mdtext
lucy/site/trunk/content/docs/test/Lucy/Object/BitVector.mdtext
lucy/site/trunk/content/docs/test/Lucy/Plan/FieldType.mdtext
lucy/site/trunk/content/docs/test/Lucy/Plan/FullTextType.mdtext
lucy/site/trunk/content/docs/test/Lucy/Plan/Schema.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/ANDQuery.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/Compiler.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/Hits.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/IndexSearcher.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/LeafQuery.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/MatchAllQuery.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/Matcher.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/NOTQuery.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/NoMatchQuery.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/ORQuery.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/PhraseQuery.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/PolySearcher.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/Query.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/QueryParser.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/RangeQuery.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/RequiredOptionalQuery.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/Searcher.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/SortRule.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/Span.mdtext
lucy/site/trunk/content/docs/test/Lucy/Search/TermQuery.mdtext
lucy/site/trunk/content/docs/test/Lucy/Simple.mdtext
lucy/site/trunk/content/docs/test/Lucy/Store/Lock.mdtext
lucy/site/trunk/content/docs/test/Lucy/Store/LockFactory.mdtext
lucy/site/trunk/content/docs/test/LucyX/Search/ProximityQuery.mdtext
Modified: lucy/site/trunk/content/docs/test/Lucy/Analysis/Analyzer.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Analysis/Analyzer.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Analysis/Analyzer.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Analysis/Analyzer.mdtext Sat Feb 27 15:04:44 2016
@@ -56,7 +56,7 @@ name="ABSTRACT_METHODS"
name="transform"
>transform</a></h3>
-<pre>my $retval = $analyzer->transform($inversion);</pre>
+<pre>my $inversion = $analyzer->transform($inversion);</pre>
<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod"
>Inversion</a> as input and returns an Inversion,
@@ -75,7 +75,7 @@ name="METHODS"
name="transform_text"
>transform_text</a></h3>
-<pre>my $retval = $analyzer->transform_text($text);</pre>
+<pre>my $inversion = $analyzer->transform_text($text);</pre>
<p>Kick off an analysis chain,
creating an Inversion from string input.
@@ -92,7 +92,7 @@ but occasionally subclasses will provide
name="split"
>split</a></h3>
-<pre>my $retval = $analyzer->split($text);</pre>
+<pre>my $arrayref = $analyzer->split($text);</pre>
<p>Analyze text and return an array of token texts.</p>
@@ -104,7 +104,7 @@ name="split"
name="dump"
>dump</a></h3>
-<pre>my $retval = $analyzer->dump();</pre>
+<pre>my $obj = $analyzer->dump();</pre>
<p>Dump the analyzer as hash.</p>
@@ -118,7 +118,7 @@ The returned object is a hash which shou
name="load"
>load</a></h3>
-<pre>my $retval = $analyzer->load($dump);</pre>
+<pre>my $obj = $analyzer->load($dump);</pre>
<p>Reconstruct an analyzer from a dump.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Analysis/CaseFolder.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Analysis/CaseFolder.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Analysis/CaseFolder.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Analysis/CaseFolder.mdtext Sat Feb 27 15:04:44 2016
@@ -52,7 +52,7 @@ name="METHODS"
name="transform"
>transform</a></h3>
-<pre>my $retval = $case_folder->transform($inversion);</pre>
+<pre>my $inversion = $case_folder->transform($inversion);</pre>
<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod"
>Inversion</a> as input and returns an Inversion,
Modified: lucy/site/trunk/content/docs/test/Lucy/Analysis/EasyAnalyzer.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Analysis/EasyAnalyzer.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Analysis/EasyAnalyzer.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Analysis/EasyAnalyzer.mdtext Sat Feb 27 15:04:44 2016
@@ -78,7 +78,7 @@ name="METHODS"
name="transform"
>transform</a></h3>
-<pre>my $retval = $easy_analyzer->transform($inversion);</pre>
+<pre>my $inversion = $easy_analyzer->transform($inversion);</pre>
<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod"
>Inversion</a> as input and returns an Inversion,
Modified: lucy/site/trunk/content/docs/test/Lucy/Analysis/Inversion.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Analysis/Inversion.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Analysis/Inversion.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Analysis/Inversion.mdtext Sat Feb 27 15:04:44 2016
@@ -65,7 +65,7 @@ name="append"
name="next"
>next</a></h3>
-<pre>my $retval = $inversion->next();</pre>
+<pre>my $token = $inversion->next();</pre>
<p>Return the next token in the Inversion until out of tokens.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Analysis/Normalizer.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Analysis/Normalizer.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Analysis/Normalizer.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Analysis/Normalizer.mdtext Sat Feb 27 15:04:44 2016
@@ -71,7 +71,7 @@ name="METHODS"
name="transform"
>transform</a></h3>
-<pre>my $retval = $normalizer->transform($inversion);</pre>
+<pre>my $inversion = $normalizer->transform($inversion);</pre>
<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod"
>Inversion</a> as input and returns an Inversion,
Modified: lucy/site/trunk/content/docs/test/Lucy/Analysis/PolyAnalyzer.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Analysis/PolyAnalyzer.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Analysis/PolyAnalyzer.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Analysis/PolyAnalyzer.mdtext Sat Feb 27 15:04:44 2016
@@ -105,7 +105,7 @@ name="METHODS"
name="get_analyzers"
>get_analyzers</a></h3>
-<pre>my $retval = $poly_analyzer->get_analyzers();</pre>
+<pre>my $arrayref = $poly_analyzer->get_analyzers();</pre>
<p>Getter for “analyzers” member.</p>
@@ -113,7 +113,7 @@ name="get_analyzers"
name="transform"
>transform</a></h3>
-<pre>my $retval = $poly_analyzer->transform($inversion);</pre>
+<pre>my $inversion = $poly_analyzer->transform($inversion);</pre>
<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod"
>Inversion</a> as input and returns an Inversion,
Modified: lucy/site/trunk/content/docs/test/Lucy/Analysis/RegexTokenizer.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Analysis/RegexTokenizer.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Analysis/RegexTokenizer.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Analysis/RegexTokenizer.mdtext Sat Feb 27 15:04:44 2016
@@ -87,7 +87,7 @@ name="METHODS"
name="transform"
>transform</a></h3>
-<pre>my $retval = $regex_tokenizer->transform($inversion);</pre>
+<pre>my $inversion = $regex_tokenizer->transform($inversion);</pre>
<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod"
>Inversion</a> as input and returns an Inversion,
Modified: lucy/site/trunk/content/docs/test/Lucy/Analysis/SnowballStemmer.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Analysis/SnowballStemmer.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Analysis/SnowballStemmer.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Analysis/SnowballStemmer.mdtext Sat Feb 27 15:04:44 2016
@@ -57,7 +57,7 @@ name="METHODS"
name="transform"
>transform</a></h3>
-<pre>my $retval = $snowball_stemmer->transform($inversion);</pre>
+<pre>my $inversion = $snowball_stemmer->transform($inversion);</pre>
<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod"
>Inversion</a> as input and returns an Inversion,
Modified: lucy/site/trunk/content/docs/test/Lucy/Analysis/SnowballStopFilter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Analysis/SnowballStopFilter.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Analysis/SnowballStopFilter.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Analysis/SnowballStopFilter.mdtext Sat Feb 27 15:04:44 2016
@@ -94,7 +94,7 @@ name="METHODS"
name="transform"
>transform</a></h3>
-<pre>my $retval = $snowball_stop_filter->transform($inversion);</pre>
+<pre>my $inversion = $snowball_stop_filter->transform($inversion);</pre>
<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod"
>Inversion</a> as input and returns an Inversion,
Modified: lucy/site/trunk/content/docs/test/Lucy/Analysis/StandardTokenizer.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Analysis/StandardTokenizer.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Analysis/StandardTokenizer.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Analysis/StandardTokenizer.mdtext Sat Feb 27 15:04:44 2016
@@ -54,7 +54,7 @@ name="METHODS"
name="transform"
>transform</a></h3>
-<pre>my $retval = $standard_tokenizer->transform($inversion);</pre>
+<pre>my $inversion = $standard_tokenizer->transform($inversion);</pre>
<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod"
>Inversion</a> as input and returns an Inversion,
Modified: lucy/site/trunk/content/docs/test/Lucy/Analysis/Token.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Analysis/Token.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Analysis/Token.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Analysis/Token.mdtext Sat Feb 27 15:04:44 2016
@@ -119,31 +119,31 @@ name="set_text"
name="get_start_offset"
>get_start_offset</a></h3>
-<pre>my $retval = $token->get_start_offset();</pre>
+<pre>my $int = $token->get_start_offset();</pre>
<h3><a class='u'
name="get_end_offset"
>get_end_offset</a></h3>
-<pre>my $retval = $token->get_end_offset();</pre>
+<pre>my $int = $token->get_end_offset();</pre>
<h3><a class='u'
name="get_boost"
>get_boost</a></h3>
-<pre>my $retval = $token->get_boost();</pre>
+<pre>my $float = $token->get_boost();</pre>
<h3><a class='u'
name="get_pos_inc"
>get_pos_inc</a></h3>
-<pre>my $retval = $token->get_pos_inc();</pre>
+<pre>my $int = $token->get_pos_inc();</pre>
<h3><a class='u'
name="get_len"
>get_len</a></h3>
-<pre>my $retval = $token->get_len();</pre>
+<pre>my $int = $token->get_len();</pre>
<h2><a class='u'
name="INHERITANCE"
Modified: lucy/site/trunk/content/docs/test/Lucy/Document/Doc.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Document/Doc.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Document/Doc.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Document/Doc.mdtext Sat Feb 27 15:04:44 2016
@@ -68,7 +68,7 @@ name="set_doc_id"
name="get_doc_id"
>get_doc_id</a></h3>
-<pre>my $retval = $doc->get_doc_id();</pre>
+<pre>my $int = $doc->get_doc_id();</pre>
<p>Retrieve internal Lucy document id.</p>
@@ -90,15 +90,15 @@ name="store"
name="get_fields"
>get_fields</a></h3>
-<pre>my $retval = $doc->get_fields();</pre>
+<pre>my $hashref = $doc->get_fields();</pre>
-<p>Return the Doc’s backing fields hash.</p>
+<p>Return the Doc's backing fields hash.</p>
<h3><a class='u'
name="get_size"
>get_size</a></h3>
-<pre>my $retval = $doc->get_size();</pre>
+<pre>my $int = $doc->get_size();</pre>
<p>Return the number of fields in the Doc.</p>
@@ -106,7 +106,7 @@ name="get_size"
name="extract"
>extract</a></h3>
-<pre>my $retval = $doc->extract($field);</pre>
+<pre>my $obj = $doc->extract($field);</pre>
<p>Retrieve the field’s value,
or NULL if the field is not present.</p>
@@ -115,7 +115,7 @@ or NULL if the field is not present.</p>
name="field_names"
>field_names</a></h3>
-<pre>my $retval = $doc->field_names();</pre>
+<pre>my $arrayref = $doc->field_names();</pre>
<p>Return a list of names of all fields present.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Document/HitDoc.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Document/HitDoc.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Document/HitDoc.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Document/HitDoc.mdtext Sat Feb 27 15:04:44 2016
@@ -41,7 +41,7 @@ name="set_score"
name="get_score"
>get_score</a></h3>
-<pre>my $retval = $hit_doc->get_score();</pre>
+<pre>my $float = $hit_doc->get_score();</pre>
<p>Get score attribute.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Highlight/Highlighter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Highlight/Highlighter.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Highlight/Highlighter.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Highlight/Highlighter.mdtext Sat Feb 27 15:04:44 2016
@@ -74,7 +74,7 @@ name="METHODS"
name="create_excerpt"
>create_excerpt</a></h3>
-<pre>my $retval = $highlighter->create_excerpt($hit_doc);</pre>
+<pre>my $string = $highlighter->create_excerpt($hit_doc);</pre>
<p>Take a HitDoc object and return a highlighted excerpt as a string if the HitDoc has a value for the specified <code>field</code>.</p>
@@ -82,7 +82,7 @@ name="create_excerpt"
name="encode"
>encode</a></h3>
-<pre>my $retval = $highlighter->encode($text);</pre>
+<pre>my $string = $highlighter->encode($text);</pre>
<p>Encode text with HTML entities.
This method is called internally by <a href="#create_excerpt" class="podlinkpod"
@@ -93,7 +93,7 @@ A subclass can override this if the text
name="highlight"
>highlight</a></h3>
-<pre>my $retval = $highlighter->highlight($text);</pre>
+<pre>my $string = $highlighter->highlight($text);</pre>
<p>Highlight a small section of text.
By default,
@@ -123,7 +123,7 @@ The default value is “</strong
name="get_pre_tag"
>get_pre_tag</a></h3>
-<pre>my $retval = $highlighter->get_pre_tag();</pre>
+<pre>my $string = $highlighter->get_pre_tag();</pre>
<p>Accessor.</p>
@@ -131,7 +131,7 @@ name="get_pre_tag"
name="get_post_tag"
>get_post_tag</a></h3>
-<pre>my $retval = $highlighter->get_post_tag();</pre>
+<pre>my $string = $highlighter->get_post_tag();</pre>
<p>Accessor.</p>
@@ -139,7 +139,7 @@ name="get_post_tag"
name="get_field"
>get_field</a></h3>
-<pre>my $retval = $highlighter->get_field();</pre>
+<pre>my $string = $highlighter->get_field();</pre>
<p>Accessor.</p>
@@ -147,7 +147,7 @@ name="get_field"
name="get_excerpt_length"
>get_excerpt_length</a></h3>
-<pre>my $retval = $highlighter->get_excerpt_length();</pre>
+<pre>my $int = $highlighter->get_excerpt_length();</pre>
<p>Accessor.</p>
@@ -155,7 +155,7 @@ name="get_excerpt_length"
name="get_searcher"
>get_searcher</a></h3>
-<pre>my $retval = $highlighter->get_searcher();</pre>
+<pre>my $searcher = $highlighter->get_searcher();</pre>
<p>Accessor.</p>
@@ -163,7 +163,7 @@ name="get_searcher"
name="get_query"
>get_query</a></h3>
-<pre>my $retval = $highlighter->get_query();</pre>
+<pre>my $query = $highlighter->get_query();</pre>
<p>Accessor.</p>
@@ -171,7 +171,7 @@ name="get_query"
name="get_compiler"
>get_compiler</a></h3>
-<pre>my $retval = $highlighter->get_compiler();</pre>
+<pre>my $compiler = $highlighter->get_compiler();</pre>
<p>Accessor for the Lucy::Search::Compiler object derived from <code>query</code> and <code>searcher</code>.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/DataReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/DataReader.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/DataReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/DataReader.mdtext Sat Feb 27 15:04:44 2016
@@ -63,7 +63,7 @@ name="ABSTRACT_METHODS"
name="aggregator"
>aggregator</a></h3>
-<pre>my $retval = $data_reader->aggregator(
+<pre>my $result = $data_reader->aggregator(
readers => $readers # required
offsets => $offsets # required
);</pre>
@@ -85,7 +85,7 @@ name="METHODS"
name="get_schema"
>get_schema</a></h3>
-<pre>my $retval = $data_reader->get_schema();</pre>
+<pre>my $schema = $data_reader->get_schema();</pre>
<p>Accessor for “schema” member var.</p>
@@ -93,7 +93,7 @@ name="get_schema"
name="get_folder"
>get_folder</a></h3>
-<pre>my $retval = $data_reader->get_folder();</pre>
+<pre>my $folder = $data_reader->get_folder();</pre>
<p>Accessor for “folder” member var.</p>
@@ -101,7 +101,7 @@ name="get_folder"
name="get_snapshot"
>get_snapshot</a></h3>
-<pre>my $retval = $data_reader->get_snapshot();</pre>
+<pre>my $snapshot = $data_reader->get_snapshot();</pre>
<p>Accessor for “snapshot” member var.</p>
@@ -109,7 +109,7 @@ name="get_snapshot"
name="get_segments"
>get_segments</a></h3>
-<pre>my $retval = $data_reader->get_segments();</pre>
+<pre>my $arrayref = $data_reader->get_segments();</pre>
<p>Accessor for “segments” member var.</p>
@@ -117,7 +117,7 @@ name="get_segments"
name="get_segment"
>get_segment</a></h3>
-<pre>my $retval = $data_reader->get_segment();</pre>
+<pre>my $segment = $data_reader->get_segment();</pre>
<p>Accessor for “segment” member var.</p>
@@ -125,7 +125,7 @@ name="get_segment"
name="get_seg_tick"
>get_seg_tick</a></h3>
-<pre>my $retval = $data_reader->get_seg_tick();</pre>
+<pre>my $int = $data_reader->get_seg_tick();</pre>
<p>Accessor for “seg_tick” member var.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/DataWriter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/DataWriter.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/DataWriter.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/DataWriter.mdtext Sat Feb 27 15:04:44 2016
@@ -94,7 +94,7 @@ etc.</p>
name="format"
>format</a></h3>
-<pre>my $retval = $data_writer->format();</pre>
+<pre>my $int = $data_writer->format();</pre>
<p>Every writer must specify a file format revision number,
which should increment each time the format changes.
@@ -148,16 +148,16 @@ indicating that they should be skipped.<
name="metadata"
>metadata</a></h3>
-<pre>my $retval = $data_writer->metadata();</pre>
+<pre>my $hashref = $data_writer->metadata();</pre>
<p>Arbitrary metadata to be serialized and stored by the Segment.
-The default implementation supplies a Hash with a single key-value pair for “format”.</p>
+The default implementation supplies a hash with a single key-value pair for “format”.</p>
<h3><a class='u'
name="get_snapshot"
>get_snapshot</a></h3>
-<pre>my $retval = $data_writer->get_snapshot();</pre>
+<pre>my $snapshot = $data_writer->get_snapshot();</pre>
<p>Accessor for “snapshot” member var.</p>
@@ -165,7 +165,7 @@ name="get_snapshot"
name="get_segment"
>get_segment</a></h3>
-<pre>my $retval = $data_writer->get_segment();</pre>
+<pre>my $segment = $data_writer->get_segment();</pre>
<p>Accessor for “segment” member var.</p>
@@ -173,7 +173,7 @@ name="get_segment"
name="get_polyreader"
>get_polyreader</a></h3>
-<pre>my $retval = $data_writer->get_polyreader();</pre>
+<pre>my $poly_reader = $data_writer->get_polyreader();</pre>
<p>Accessor for “polyreader” member var.</p>
@@ -181,7 +181,7 @@ name="get_polyreader"
name="get_schema"
>get_schema</a></h3>
-<pre>my $retval = $data_writer->get_schema();</pre>
+<pre>my $schema = $data_writer->get_schema();</pre>
<p>Accessor for “schema” member var.</p>
@@ -189,7 +189,7 @@ name="get_schema"
name="get_folder"
>get_folder</a></h3>
-<pre>my $retval = $data_writer->get_folder();</pre>
+<pre>my $folder = $data_writer->get_folder();</pre>
<p>Accessor for “folder” member var.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/DeletionsWriter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/DeletionsWriter.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/DeletionsWriter.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/DeletionsWriter.mdtext Sat Feb 27 15:04:44 2016
@@ -76,7 +76,7 @@ name="delete_by_query"
name="updated"
>updated</a></h3>
-<pre>my $retval = $deletions_writer->updated();</pre>
+<pre>my $bool = $deletions_writer->updated();</pre>
<p>Returns true if there are updates that need to be written.</p>
@@ -84,7 +84,7 @@ name="updated"
name="seg_del_count"
>seg_del_count</a></h3>
-<pre>my $retval = $deletions_writer->seg_del_count($seg_name);</pre>
+<pre>my $int = $deletions_writer->seg_del_count($seg_name);</pre>
<p>Return the number of deletions for a given segment.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/DocReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/DocReader.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/DocReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/DocReader.mdtext Sat Feb 27 15:04:44 2016
@@ -32,7 +32,7 @@ name="ABSTRACT_METHODS"
name="fetch_doc"
>fetch_doc</a></h3>
-<pre>my $retval = $doc_reader->fetch_doc($doc_id);</pre>
+<pre>my $hit_doc = $doc_reader->fetch_doc($doc_id);</pre>
<p>Retrieve the document identified by <code>doc_id</code>.</p>
@@ -46,7 +46,7 @@ name="METHODS"
name="aggregator"
>aggregator</a></h3>
-<pre>my $retval = $doc_reader->aggregator(
+<pre>my $result = $doc_reader->aggregator(
readers => $readers # required
offsets => $offsets # required
);</pre>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/IndexManager.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/IndexManager.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/IndexManager.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/IndexManager.mdtext Sat Feb 27 15:04:44 2016
@@ -85,7 +85,7 @@ IndexReader) will use this method to ins
name="get_folder"
>get_folder</a></h3>
-<pre>my $retval = $index_manager->get_folder();</pre>
+<pre>my $folder = $index_manager->get_folder();</pre>
<p>Getter for <code>folder</code> member.</p>
@@ -93,7 +93,7 @@ name="get_folder"
name="get_host"
>get_host</a></h3>
-<pre>my $retval = $index_manager->get_host();</pre>
+<pre>my $string = $index_manager->get_host();</pre>
<p>Getter for <code>host</code> member.</p>
@@ -101,7 +101,7 @@ name="get_host"
name="recycle"
>recycle</a></h3>
-<pre>my $retval = $index_manager->recycle(
+<pre>my $arrayref = $index_manager->recycle(
reader => $reader # required
del_writer => $del_writer # required
cutoff => $cutoff # required
@@ -126,7 +126,7 @@ The default implementation prefers small
name="make_write_lock"
>make_write_lock</a></h3>
-<pre>my $retval = $index_manager->make_write_lock();</pre>
+<pre>my $lock = $index_manager->make_write_lock();</pre>
<p>Create the Lock which controls access to modifying the logical content of the index.</p>
@@ -143,7 +143,7 @@ Default: 1000 milliseconds.</p>
name="get_write_lock_timeout"
>get_write_lock_timeout</a></h3>
-<pre>my $retval = $index_manager->get_write_lock_timeout();</pre>
+<pre>my $int = $index_manager->get_write_lock_timeout();</pre>
<p>Getter for write lock timeout.</p>
@@ -160,7 +160,7 @@ Default: 100 milliseconds.</p>
name="get_write_lock_interval"
>get_write_lock_interval</a></h3>
-<pre>my $retval = $index_manager->get_write_lock_interval();</pre>
+<pre>my $int = $index_manager->get_write_lock_interval();</pre>
<p>Getter for write lock retry interval.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/IndexReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/IndexReader.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/IndexReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/IndexReader.mdtext Sat Feb 27 15:04:44 2016
@@ -84,7 +84,7 @@ name="ABSTRACT_METHODS"
name="doc_max"
>doc_max</a></h3>
-<pre>my $retval = $index_reader->doc_max();</pre>
+<pre>my $int = $index_reader->doc_max();</pre>
<p>Return the maximum number of documents available to the reader,
which is also the highest possible internal document id.
@@ -94,7 +94,7 @@ Documents which have been marked as dele
name="doc_count"
>doc_count</a></h3>
-<pre>my $retval = $index_reader->doc_count();</pre>
+<pre>my $int = $index_reader->doc_count();</pre>
<p>Return the number of documents available to the reader,
subtracting any that are marked as deleted.</p>
@@ -103,7 +103,7 @@ subtracting any that are marked as delet
name="del_count"
>del_count</a></h3>
-<pre>my $retval = $index_reader->del_count();</pre>
+<pre>my $int = $index_reader->del_count();</pre>
<p>Return the number of documents which have been marked as deleted but not yet purged from the index.</p>
@@ -111,7 +111,7 @@ name="del_count"
name="offsets"
>offsets</a></h3>
-<pre>my $retval = $index_reader->offsets();</pre>
+<pre>my $i32_array = $index_reader->offsets();</pre>
<p>Return an array with one entry for each segment,
corresponding to segment doc_id start offset.</p>
@@ -120,7 +120,7 @@ corresponding to segment doc_id start of
name="seg_readers"
>seg_readers</a></h3>
-<pre>my $retval = $index_reader->seg_readers();</pre>
+<pre>my $arrayref = $index_reader->seg_readers();</pre>
<p>Return an array of all the SegReaders represented within the IndexReader.</p>
@@ -132,7 +132,7 @@ name="METHODS"
name="obtain"
>obtain</a></h3>
-<pre>my $retval = $index_reader->obtain($api);</pre>
+<pre>my $data_reader = $index_reader->obtain($api);</pre>
<p>Fetch a component,
or throw an error if the component can’t be found.</p>
@@ -145,7 +145,7 @@ or throw an error if the component can&#
name="fetch"
>fetch</a></h3>
-<pre>my $retval = $index_reader->fetch($api);</pre>
+<pre>my $data_reader = $index_reader->fetch($api);</pre>
<p>Fetch a component,
or return undef if the component can’t be found.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/Indexer.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/Indexer.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/Indexer.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/Indexer.mdtext Sat Feb 27 15:04:44 2016
@@ -240,7 +240,7 @@ so that <a href="#commit" class="podlink
name="get_schema"
>get_schema</a></h3>
-<pre>my $retval = $indexer->get_schema();</pre>
+<pre>my $schema = $indexer->get_schema();</pre>
<p>Accessor for schema.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/Lexicon.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/Lexicon.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/Lexicon.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/Lexicon.mdtext Sat Feb 27 15:04:44 2016
@@ -52,7 +52,7 @@ reset the iterator.</p>
name="next"
>next</a></h3>
-<pre>my $retval = $lexicon->next();</pre>
+<pre>my $bool = $lexicon->next();</pre>
<p>Proceed to the next term.</p>
@@ -73,7 +73,7 @@ name="reset"
name="get_term"
>get_term</a></h3>
-<pre>my $retval = $lexicon->get_term();</pre>
+<pre>my $obj = $lexicon->get_term();</pre>
<p>Return the current term,
or undef if the iterator is not in a valid state.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/LexiconReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/LexiconReader.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/LexiconReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/LexiconReader.mdtext Sat Feb 27 15:04:44 2016
@@ -30,7 +30,7 @@ name="ABSTRACT_METHODS"
name="lexicon"
>lexicon</a></h3>
-<pre>my $retval = $lexicon_reader->lexicon(
+<pre>my $lexicon = $lexicon_reader->lexicon(
field => $field # required
term => $term # default: undef
);</pre>
@@ -49,7 +49,7 @@ or if no documents contain a value for t
name="doc_freq"
>doc_freq</a></h3>
-<pre>my $retval = $lexicon_reader->doc_freq(
+<pre>my $int = $lexicon_reader->doc_freq(
field => $field # required
term => $term # required
);</pre>
@@ -64,7 +64,7 @@ name="METHODS"
name="aggregator"
>aggregator</a></h3>
-<pre>my $retval = $lexicon_reader->aggregator(
+<pre>my $result = $lexicon_reader->aggregator(
readers => $readers # required
offsets => $offsets # required
);</pre>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/PolyReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/PolyReader.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/PolyReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/PolyReader.mdtext Sat Feb 27 15:04:44 2016
@@ -44,7 +44,7 @@ name="METHODS"
name="doc_max"
>doc_max</a></h3>
-<pre>my $retval = $poly_reader->doc_max();</pre>
+<pre>my $int = $poly_reader->doc_max();</pre>
<p>Return the maximum number of documents available to the reader,
which is also the highest possible internal document id.
@@ -54,7 +54,7 @@ Documents which have been marked as dele
name="doc_count"
>doc_count</a></h3>
-<pre>my $retval = $poly_reader->doc_count();</pre>
+<pre>my $int = $poly_reader->doc_count();</pre>
<p>Return the number of documents available to the reader,
subtracting any that are marked as deleted.</p>
@@ -63,7 +63,7 @@ subtracting any that are marked as delet
name="del_count"
>del_count</a></h3>
-<pre>my $retval = $poly_reader->del_count();</pre>
+<pre>my $int = $poly_reader->del_count();</pre>
<p>Return the number of documents which have been marked as deleted but not yet purged from the index.</p>
@@ -71,7 +71,7 @@ name="del_count"
name="offsets"
>offsets</a></h3>
-<pre>my $retval = $poly_reader->offsets();</pre>
+<pre>my $i32_array = $poly_reader->offsets();</pre>
<p>Return an array with one entry for each segment,
corresponding to segment doc_id start offset.</p>
@@ -80,7 +80,7 @@ corresponding to segment doc_id start of
name="seg_readers"
>seg_readers</a></h3>
-<pre>my $retval = $poly_reader->seg_readers();</pre>
+<pre>my $arrayref = $poly_reader->seg_readers();</pre>
<p>Return an array of all the SegReaders represented within the IndexReader.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/PostingList.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/PostingList.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/PostingList.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/PostingList.mdtext Sat Feb 27 15:04:44 2016
@@ -40,7 +40,7 @@ name="ABSTRACT_METHODS"
name="get_doc_freq"
>get_doc_freq</a></h3>
-<pre>my $retval = $posting_list->get_doc_freq();</pre>
+<pre>my $int = $posting_list->get_doc_freq();</pre>
<p>Return the number of documents that the PostingList contains.
(This number will include any documents which have been marked as deleted but not yet purged.)</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/PostingListReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/PostingListReader.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/PostingListReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/PostingListReader.mdtext Sat Feb 27 15:04:44 2016
@@ -35,7 +35,7 @@ name="ABSTRACT_METHODS"
name="posting_list"
>posting_list</a></h3>
-<pre>my $retval = $posting_list_reader->posting_list(
+<pre>my $posting_list = $posting_list_reader->posting_list(
field => $field # default: undef
term => $term # default: undef
);</pre>
@@ -59,7 +59,7 @@ name="METHODS"
name="aggregator"
>aggregator</a></h3>
-<pre>my $retval = $posting_list_reader->aggregator(
+<pre>my $result = $posting_list_reader->aggregator(
readers => $readers # required
offsets => $offsets # required
);</pre>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/SegReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/SegReader.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/SegReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/SegReader.mdtext Sat Feb 27 15:04:44 2016
@@ -48,7 +48,7 @@ name="METHODS"
name="get_seg_name"
>get_seg_name</a></h3>
-<pre>my $retval = $seg_reader->get_seg_name();</pre>
+<pre>my $string = $seg_reader->get_seg_name();</pre>
<p>Return the name of the segment.</p>
@@ -56,7 +56,7 @@ name="get_seg_name"
name="get_seg_num"
>get_seg_num</a></h3>
-<pre>my $retval = $seg_reader->get_seg_num();</pre>
+<pre>my $int = $seg_reader->get_seg_num();</pre>
<p>Return the number of the segment.</p>
@@ -64,7 +64,7 @@ name="get_seg_num"
name="del_count"
>del_count</a></h3>
-<pre>my $retval = $seg_reader->del_count();</pre>
+<pre>my $int = $seg_reader->del_count();</pre>
<p>Return the number of documents which have been marked as deleted but not yet purged from the index.</p>
@@ -72,7 +72,7 @@ name="del_count"
name="doc_max"
>doc_max</a></h3>
-<pre>my $retval = $seg_reader->doc_max();</pre>
+<pre>my $int = $seg_reader->doc_max();</pre>
<p>Return the maximum number of documents available to the reader,
which is also the highest possible internal document id.
@@ -82,7 +82,7 @@ Documents which have been marked as dele
name="doc_count"
>doc_count</a></h3>
-<pre>my $retval = $seg_reader->doc_count();</pre>
+<pre>my $int = $seg_reader->doc_count();</pre>
<p>Return the number of documents available to the reader,
subtracting any that are marked as deleted.</p>
@@ -91,7 +91,7 @@ subtracting any that are marked as delet
name="_offsets"
>_offsets</a></h3>
-<pre>my $retval = $seg_reader->_offsets();</pre>
+<pre>my $i32_array = $seg_reader->_offsets();</pre>
<p>Return an array with one entry for each segment,
corresponding to segment doc_id start offset.</p>
@@ -100,7 +100,7 @@ corresponding to segment doc_id start of
name="seg_readers"
>seg_readers</a></h3>
-<pre>my $retval = $seg_reader->seg_readers();</pre>
+<pre>my $arrayref = $seg_reader->seg_readers();</pre>
<p>Return an array of all the SegReaders represented within the IndexReader.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/SegWriter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/SegWriter.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/SegWriter.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/SegWriter.mdtext Sat Feb 27 15:04:44 2016
@@ -56,7 +56,7 @@ so you may also want to call <a href="#a
name="fetch"
>fetch</a></h3>
-<pre>my $retval = $seg_writer->fetch($api);</pre>
+<pre>my $obj = $seg_writer->fetch($api);</pre>
<p>Retrieve a registered component.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/Segment.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/Segment.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/Segment.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/Segment.mdtext Sat Feb 27 15:04:44 2016
@@ -69,7 +69,7 @@ name="METHODS"
name="add_field"
>add_field</a></h3>
-<pre>my $retval = $segment->add_field($field);</pre>
+<pre>my $int = $segment->add_field($field);</pre>
<p>Register a new field and assign it a field number.
If the field was already known,
@@ -91,7 +91,7 @@ name="store_metadata"
metadata => $metadata # required
);</pre>
-<p>Store arbitrary information in the segment’s metadata Hash,
+<p>Store arbitrary information in the segment’s metadata hash,
to be serialized later.
Throws an error if <code>key</code> is used twice.</p>
@@ -105,7 +105,7 @@ Throws an error if <code>key</code> is u
name="fetch_metadata"
>fetch_metadata</a></h3>
-<pre>my $retval = $segment->fetch_metadata($key);</pre>
+<pre>my $obj = $segment->fetch_metadata($key);</pre>
<p>Fetch a value from the Segment’s metadata hash.</p>
@@ -113,7 +113,7 @@ name="fetch_metadata"
name="field_num"
>field_num</a></h3>
-<pre>my $retval = $segment->field_num($field);</pre>
+<pre>my $int = $segment->field_num($field);</pre>
<p>Given a field name,
return its field number for this segment (which may differ from its number in other segments).
@@ -127,7 +127,7 @@ Return 0 (an invalid field number) if th
name="field_name"
>field_name</a></h3>
-<pre>my $retval = $segment->field_name($field_num);</pre>
+<pre>my $string = $segment->field_name($field_num);</pre>
<p>Given a field number,
return the name of its field,
@@ -137,7 +137,7 @@ or undef if the field name can’t b
name="get_name"
>get_name</a></h3>
-<pre>my $retval = $segment->get_name();</pre>
+<pre>my $string = $segment->get_name();</pre>
<p>Getter for the object’s seg name.</p>
@@ -145,7 +145,7 @@ name="get_name"
name="get_number"
>get_number</a></h3>
-<pre>my $retval = $segment->get_number();</pre>
+<pre>my $int = $segment->get_number();</pre>
<p>Getter for the segment number.</p>
@@ -161,7 +161,7 @@ name="set_count"
name="get_count"
>get_count</a></h3>
-<pre>my $retval = $segment->get_count();</pre>
+<pre>my $int = $segment->get_count();</pre>
<p>Getter for the object’s document count.</p>
@@ -169,7 +169,7 @@ name="get_count"
name="compare_to"
>compare_to</a></h3>
-<pre>my $retval = $segment->compare_to($other);</pre>
+<pre>my $int = $segment->compare_to($other);</pre>
<p>Compare by segment number.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/Similarity.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/Similarity.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/Similarity.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/Similarity.mdtext Sat Feb 27 15:04:44 2016
@@ -59,7 +59,7 @@ name="METHODS"
name="length_norm"
>length_norm</a></h3>
-<pre>my $retval = $similarity->length_norm($num_tokens);</pre>
+<pre>my $float = $similarity->length_norm($num_tokens);</pre>
<p>Dampen the scores of long documents.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/Snapshot.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/Snapshot.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/Snapshot.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/Snapshot.mdtext Sat Feb 27 15:04:44 2016
@@ -52,7 +52,7 @@ name="METHODS"
name="list"
>list</a></h3>
-<pre>my $retval = $snapshot->list();</pre>
+<pre>my $arrayref = $snapshot->list();</pre>
<p>Return an array of all entries.</p>
@@ -60,7 +60,7 @@ name="list"
name="num_entries"
>num_entries</a></h3>
-<pre>my $retval = $snapshot->num_entries();</pre>
+<pre>my $int = $snapshot->num_entries();</pre>
<p>Return the number of entries (including directories).</p>
@@ -76,7 +76,7 @@ name="add_entry"
name="delete_entry"
>delete_entry</a></h3>
-<pre>my $retval = $snapshot->delete_entry($entry);</pre>
+<pre>my $bool = $snapshot->delete_entry($entry);</pre>
<p>Delete a filepath from the snapshot.</p>
@@ -87,7 +87,7 @@ false otherwise.</p>
name="read_file"
>read_file</a></h3>
-<pre>my $retval = $snapshot->read_file(
+<pre>my $result = $snapshot->read_file(
folder => $folder # required
path => $path # default: undef
);</pre>
@@ -137,7 +137,7 @@ name="set_path"
name="get_path"
>get_path</a></h3>
-<pre>my $retval = $snapshot->get_path();</pre>
+<pre>my $string = $snapshot->get_path();</pre>
<p>Get the path to the snapshot file.
Initially undef; updated by <a href="#read_file" class="podlinkpod"
Modified: lucy/site/trunk/content/docs/test/Lucy/Object/BitVector.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Object/BitVector.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Object/BitVector.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Object/BitVector.mdtext Sat Feb 27 15:04:44 2016
@@ -53,7 +53,7 @@ name="METHODS"
name="get"
>get</a></h3>
-<pre>my $retval = $bit_vector->get($tick);</pre>
+<pre>my $bool = $bit_vector->get($tick);</pre>
<p>Return true if the bit at <code>tick</code> has been set,
false if it hasn’t (regardless of whether it lies within the bounds of the object’s capacity).</p>
@@ -78,7 +78,7 @@ name="set"
name="next_hit"
>next_hit</a></h3>
-<pre>my $retval = $bit_vector->next_hit($tick);</pre>
+<pre>my $int = $bit_vector->next_hit($tick);</pre>
<p>Returns the next set bit equal to or greater than <code>tick</code>,
or -1 if no such bit exists.</p>
@@ -203,7 +203,7 @@ name="flip_block"
name="count"
>count</a></h3>
-<pre>my $retval = $bit_vector->count();</pre>
+<pre>my $int = $bit_vector->count();</pre>
<p>Return a count of the number of set bits.</p>
@@ -211,7 +211,7 @@ name="count"
name="to_array"
>to_array</a></h3>
-<pre>my $retval = $bit_vector->to_array();</pre>
+<pre>my $i32_array = $bit_vector->to_array();</pre>
<p>Return an array where each element represents a set bit.</p>
@@ -219,7 +219,7 @@ name="to_array"
name="clone"
>clone</a></h3>
-<pre>my $retval = $bit_vector->clone();</pre>
+<pre>my $result = $bit_vector->clone();</pre>
<p>Return a clone of the object.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Plan/FieldType.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Plan/FieldType.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Plan/FieldType.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Plan/FieldType.mdtext Sat Feb 27 15:04:44 2016
@@ -69,7 +69,7 @@ name="set_boost"
name="get_boost"
>get_boost</a></h3>
-<pre>my $retval = $field_type->get_boost();</pre>
+<pre>my $float = $field_type->get_boost();</pre>
<p>Accessor for <code>boost</code>.</p>
@@ -85,7 +85,7 @@ name="set_indexed"
name="indexed"
>indexed</a></h3>
-<pre>my $retval = $field_type->indexed();</pre>
+<pre>my $bool = $field_type->indexed();</pre>
<p>Accessor for <code>indexed</code>.</p>
@@ -101,7 +101,7 @@ name="set_stored"
name="stored"
>stored</a></h3>
-<pre>my $retval = $field_type->stored();</pre>
+<pre>my $bool = $field_type->stored();</pre>
<p>Accessor for <code>stored</code>.</p>
@@ -117,7 +117,7 @@ name="set_sortable"
name="sortable"
>sortable</a></h3>
-<pre>my $retval = $field_type->sortable();</pre>
+<pre>my $bool = $field_type->sortable();</pre>
<p>Accessor for <code>sortable</code>.</p>
@@ -125,7 +125,7 @@ name="sortable"
name="binary"
>binary</a></h3>
-<pre>my $retval = $field_type->binary();</pre>
+<pre>my $bool = $field_type->binary();</pre>
<p>Indicate whether the field contains binary data.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Plan/FullTextType.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Plan/FullTextType.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Plan/FullTextType.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Plan/FullTextType.mdtext Sat Feb 27 15:04:44 2016
@@ -87,7 +87,7 @@ name="set_highlightable"
name="highlightable"
>highlightable</a></h3>
-<pre>my $retval = $full_text_type->highlightable();</pre>
+<pre>my $bool = $full_text_type->highlightable();</pre>
<p>Accessor for “highlightable” property.</p>
@@ -95,7 +95,7 @@ name="highlightable"
name="get_analyzer"
>get_analyzer</a></h3>
-<pre>my $retval = $full_text_type->get_analyzer();</pre>
+<pre>my $analyzer = $full_text_type->get_analyzer();</pre>
<p>Accessor for the type’s analyzer.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Plan/Schema.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Plan/Schema.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Plan/Schema.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Plan/Schema.mdtext Sat Feb 27 15:04:44 2016
@@ -59,7 +59,7 @@ name="METHODS"
name="architecture"
>architecture</a></h3>
-<pre>my $retval = $schema->architecture();</pre>
+<pre>my $architecture = $schema->architecture();</pre>
<p>Factory method which creates an Architecture object for this index.</p>
@@ -88,7 +88,7 @@ it will merely test to verify that the s
name="fetch_type"
>fetch_type</a></h3>
-<pre>my $retval = $schema->fetch_type($field);</pre>
+<pre>my $field_type = $schema->fetch_type($field);</pre>
<p>Return the FieldType for the specified field.
If the field can’t be found,
@@ -98,8 +98,8 @@ return undef.</p>
name="fetch_sim"
>fetch_sim</a></h3>
-<pre>my $retval = $schema->fetch_sim($field);
-my $retval = $schema->fetch_sim(); # default: undef</pre>
+<pre>my $similarity = $schema->fetch_sim($field);
+my $similarity = $schema->fetch_sim(); # default: undef</pre>
<p>Return the Similarity for the specified field,
or undef if either the field can’t be found or it isn’t associated with a Similarity.</p>
@@ -108,7 +108,7 @@ or undef if either the field can’t
name="num_fields"
>num_fields</a></h3>
-<pre>my $retval = $schema->num_fields();</pre>
+<pre>my $int = $schema->num_fields();</pre>
<p>Return the number of fields currently defined.</p>
@@ -116,7 +116,7 @@ name="num_fields"
name="all_fields"
>all_fields</a></h3>
-<pre>my $retval = $schema->all_fields();</pre>
+<pre>my $arrayref = $schema->all_fields();</pre>
<p>Return all the Schema’s field names as an array.</p>
@@ -124,7 +124,7 @@ name="all_fields"
name="get_architecture"
>get_architecture</a></h3>
-<pre>my $retval = $schema->get_architecture();</pre>
+<pre>my $architecture = $schema->get_architecture();</pre>
<p>Return the Schema instance’s internal Architecture object.</p>
@@ -132,7 +132,7 @@ name="get_architecture"
name="get_similarity"
>get_similarity</a></h3>
-<pre>my $retval = $schema->get_similarity();</pre>
+<pre>my $similarity = $schema->get_similarity();</pre>
<p>Return the Schema instance’s internal Similarity object.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/ANDQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/ANDQuery.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/ANDQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/ANDQuery.mdtext Sat Feb 27 15:04:44 2016
@@ -54,7 +54,7 @@ name="METHODS"
name="make_compiler"
>make_compiler</a></h3>
-<pre>my $retval = $and_query->make_compiler(
+<pre>my $compiler = $and_query->make_compiler(
searcher => $searcher # required
boost => $boost # required
subordinate => $subordinate # default: false
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/Compiler.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/Compiler.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/Compiler.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/Compiler.mdtext Sat Feb 27 15:04:44 2016
@@ -100,7 +100,7 @@ name="ABSTRACT_METHODS"
name="make_matcher"
>make_matcher</a></h3>
-<pre>my $retval = $compiler->make_matcher(
+<pre>my $matcher = $compiler->make_matcher(
reader => $reader # required
need_score => $need_score # required
);</pre>
@@ -125,7 +125,7 @@ name="METHODS"
name="get_weight"
>get_weight</a></h3>
-<pre>my $retval = $compiler->get_weight();</pre>
+<pre>my $float = $compiler->get_weight();</pre>
<p>Return the Compiler’s numerical weight,
a scoring multiplier.
@@ -136,7 +136,7 @@ returns the object’s boost.</p>
name="get_similarity"
>get_similarity</a></h3>
-<pre>my $retval = $compiler->get_similarity();</pre>
+<pre>my $similarity = $compiler->get_similarity();</pre>
<p>Accessor for the Compiler’s Similarity object.</p>
@@ -144,7 +144,7 @@ name="get_similarity"
name="get_parent"
>get_parent</a></h3>
-<pre>my $retval = $compiler->get_parent();</pre>
+<pre>my $query = $compiler->get_parent();</pre>
<p>Accessor for the Compiler’s parent Query object.</p>
@@ -152,7 +152,7 @@ name="get_parent"
name="sum_of_squared_weights"
>sum_of_squared_weights</a></h3>
-<pre>my $retval = $compiler->sum_of_squared_weights();</pre>
+<pre>my $float = $compiler->sum_of_squared_weights();</pre>
<p>Compute and return a raw weighting factor.
(This quantity is used by <a href="#normalize" class="podlinkpod"
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/Hits.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/Hits.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/Hits.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/Hits.mdtext Sat Feb 27 15:04:44 2016
@@ -36,7 +36,7 @@ name="METHODS"
name="next"
>next</a></h3>
-<pre>my $retval = $hits->next();</pre>
+<pre>my $hit_doc = $hits->next();</pre>
<p>Return the next hit,
or undef when the iterator is exhausted.</p>
@@ -45,7 +45,7 @@ or undef when the iterator is exhausted.
name="total_hits"
>total_hits</a></h3>
-<pre>my $retval = $hits->total_hits();</pre>
+<pre>my $int = $hits->total_hits();</pre>
<p>Return the total number of documents which matched the Query used to produce the Hits object.
Note that this is the total number of matches,
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/IndexSearcher.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/IndexSearcher.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/IndexSearcher.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/IndexSearcher.mdtext Sat Feb 27 15:04:44 2016
@@ -64,7 +64,7 @@ name="METHODS"
name="doc_max"
>doc_max</a></h3>
-<pre>my $retval = $index_searcher->doc_max();</pre>
+<pre>my $int = $index_searcher->doc_max();</pre>
<p>Return the maximum number of docs in the collection represented by the Searcher,
which is also the highest possible internal doc id.
@@ -74,7 +74,7 @@ Documents which have been marked as dele
name="doc_freq"
>doc_freq</a></h3>
-<pre>my $retval = $index_searcher->doc_freq(
+<pre>my $int = $index_searcher->doc_freq(
field => $field # required
term => $term # required
);</pre>
@@ -110,7 +110,7 @@ feeding them into a <a href="../../Lucy/
name="fetch_doc"
>fetch_doc</a></h3>
-<pre>my $retval = $index_searcher->fetch_doc($doc_id);</pre>
+<pre>my $hit_doc = $index_searcher->fetch_doc($doc_id);</pre>
<p>Retrieve a document.
Throws an error if the doc id is out of range.</p>
@@ -123,7 +123,7 @@ Throws an error if the doc id is out of
name="get_reader"
>get_reader</a></h3>
-<pre>my $retval = $index_searcher->get_reader();</pre>
+<pre>my $index_reader = $index_searcher->get_reader();</pre>
<p>Accessor for the object’s <code>reader</code> member.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/LeafQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/LeafQuery.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/LeafQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/LeafQuery.mdtext Sat Feb 27 15:04:44 2016
@@ -72,7 +72,7 @@ name="METHODS"
name="get_field"
>get_field</a></h3>
-<pre>my $retval = $leaf_query->get_field();</pre>
+<pre>my $string = $leaf_query->get_field();</pre>
<p>Accessor for object’s <code>field</code> attribute.</p>
@@ -80,7 +80,7 @@ name="get_field"
name="get_text"
>get_text</a></h3>
-<pre>my $retval = $leaf_query->get_text();</pre>
+<pre>my $string = $leaf_query->get_text();</pre>
<p>Accessor for object’s <code>text</code> attribute.</p>
@@ -88,7 +88,7 @@ name="get_text"
name="make_compiler"
>make_compiler</a></h3>
-<pre>my $retval = $leaf_query->make_compiler(
+<pre>my $compiler = $leaf_query->make_compiler(
searcher => $searcher # required
boost => $boost # required
subordinate => $subordinate # default: false
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/MatchAllQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/MatchAllQuery.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/MatchAllQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/MatchAllQuery.mdtext Sat Feb 27 15:04:44 2016
@@ -39,7 +39,7 @@ name="METHODS"
name="make_compiler"
>make_compiler</a></h3>
-<pre>my $retval = $match_all_query->make_compiler(
+<pre>my $compiler = $match_all_query->make_compiler(
searcher => $searcher # required
boost => $boost # required
subordinate => $subordinate # default: false
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/Matcher.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/Matcher.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/Matcher.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/Matcher.mdtext Sat Feb 27 15:04:44 2016
@@ -44,7 +44,7 @@ name="ABSTRACT_METHODS"
name="next"
>next</a></h3>
-<pre>my $retval = $matcher->next();</pre>
+<pre>my $int = $matcher->next();</pre>
<p>Proceed to the next doc id.</p>
@@ -55,7 +55,7 @@ or 0 once the iterator is exhausted.</p>
name="get_doc_id"
>get_doc_id</a></h3>
-<pre>my $retval = $matcher->get_doc_id();</pre>
+<pre>my $int = $matcher->get_doc_id();</pre>
<p>Return the current doc id.
Valid only after a successful call to <a href="#next" class="podlinkpod"
@@ -66,7 +66,7 @@ Valid only after a successful call to <a
name="score"
>score</a></h3>
-<pre>my $retval = $matcher->score();</pre>
+<pre>my $float = $matcher->score();</pre>
<p>Return the score of the current document.</p>
@@ -81,7 +81,7 @@ name="METHODS"
name="advance"
>advance</a></h3>
-<pre>my $retval = $matcher->advance($target);</pre>
+<pre>my $int = $matcher->advance($target);</pre>
<p>Advance the iterator to the first doc id greater than or equal to <code>target</code>.
The default implementation simply calls <a href="#next" class="podlinkpod"
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/NOTQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/NOTQuery.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/NOTQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/NOTQuery.mdtext Sat Feb 27 15:04:44 2016
@@ -59,7 +59,7 @@ name="METHODS"
name="get_negated_query"
>get_negated_query</a></h3>
-<pre>my $retval = $not_query->get_negated_query();</pre>
+<pre>my $query = $not_query->get_negated_query();</pre>
<p>Accessor for the object’s negated query.</p>
@@ -75,7 +75,7 @@ name="set_negated_query"
name="make_compiler"
>make_compiler</a></h3>
-<pre>my $retval = $not_query->make_compiler(
+<pre>my $compiler = $not_query->make_compiler(
searcher => $searcher # required
boost => $boost # required
subordinate => $subordinate # default: false
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/NoMatchQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/NoMatchQuery.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/NoMatchQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/NoMatchQuery.mdtext Sat Feb 27 15:04:44 2016
@@ -39,7 +39,7 @@ name="METHODS"
name="make_compiler"
>make_compiler</a></h3>
-<pre>my $retval = $no_match_query->make_compiler(
+<pre>my $compiler = $no_match_query->make_compiler(
searcher => $searcher # required
boost => $boost # required
subordinate => $subordinate # default: false
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/ORQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/ORQuery.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/ORQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/ORQuery.mdtext Sat Feb 27 15:04:44 2016
@@ -54,7 +54,7 @@ name="METHODS"
name="make_compiler"
>make_compiler</a></h3>
-<pre>my $retval = $or_query->make_compiler(
+<pre>my $compiler = $or_query->make_compiler(
searcher => $searcher # required
boost => $boost # required
subordinate => $subordinate # default: false
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/PhraseQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/PhraseQuery.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/PhraseQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/PhraseQuery.mdtext Sat Feb 27 15:04:44 2016
@@ -55,7 +55,7 @@ name="METHODS"
name="get_field"
>get_field</a></h3>
-<pre>my $retval = $phrase_query->get_field();</pre>
+<pre>my $string = $phrase_query->get_field();</pre>
<p>Accessor for object’s field attribute.</p>
@@ -63,7 +63,7 @@ name="get_field"
name="get_terms"
>get_terms</a></h3>
-<pre>my $retval = $phrase_query->get_terms();</pre>
+<pre>my $arrayref = $phrase_query->get_terms();</pre>
<p>Accessor for object’s array of terms.</p>
@@ -71,7 +71,7 @@ name="get_terms"
name="make_compiler"
>make_compiler</a></h3>
-<pre>my $retval = $phrase_query->make_compiler(
+<pre>my $compiler = $phrase_query->make_compiler(
searcher => $searcher # required
boost => $boost # required
subordinate => $subordinate # default: false
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/PolySearcher.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/PolySearcher.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/PolySearcher.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/PolySearcher.mdtext Sat Feb 27 15:04:44 2016
@@ -58,7 +58,7 @@ name="METHODS"
name="doc_max"
>doc_max</a></h3>
-<pre>my $retval = $poly_searcher->doc_max();</pre>
+<pre>my $int = $poly_searcher->doc_max();</pre>
<p>Return the maximum number of docs in the collection represented by the Searcher,
which is also the highest possible internal doc id.
@@ -68,7 +68,7 @@ Documents which have been marked as dele
name="doc_freq"
>doc_freq</a></h3>
-<pre>my $retval = $poly_searcher->doc_freq(
+<pre>my $int = $poly_searcher->doc_freq(
field => $field # required
term => $term # required
);</pre>
@@ -104,7 +104,7 @@ feeding them into a <a href="../../Lucy/
name="fetch_doc"
>fetch_doc</a></h3>
-<pre>my $retval = $poly_searcher->fetch_doc($doc_id);</pre>
+<pre>my $hit_doc = $poly_searcher->fetch_doc($doc_id);</pre>
<p>Retrieve a document.
Throws an error if the doc id is out of range.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/Query.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/Query.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/Query.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/Query.mdtext Sat Feb 27 15:04:44 2016
@@ -78,7 +78,7 @@ name="ABSTRACT_METHODS"
name="make_compiler"
>make_compiler</a></h3>
-<pre>my $retval = $query->make_compiler(
+<pre>my $compiler = $query->make_compiler(
searcher => $searcher # required
boost => $boost # required
subordinate => $subordinate # default: false
@@ -113,7 +113,7 @@ name="set_boost"
name="get_boost"
>get_boost</a></h3>
-<pre>my $retval = $query->get_boost();</pre>
+<pre>my $float = $query->get_boost();</pre>
<p>Get the Query’s boost.</p>
@@ -121,13 +121,13 @@ name="get_boost"
name="dump"
>dump</a></h3>
-<pre>my $retval = $query->dump();</pre>
+<pre>my $obj = $query->dump();</pre>
<h3><a class='u'
name="load"
>load</a></h3>
-<pre>my $retval = $query->load($dump);</pre>
+<pre>my $obj = $query->load($dump);</pre>
<h2><a class='u'
name="INHERITANCE"
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/QueryParser.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/QueryParser.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/QueryParser.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/QueryParser.mdtext Sat Feb 27 15:04:44 2016
@@ -107,8 +107,8 @@ name="METHODS"
name="parse"
>parse</a></h3>
-<pre>my $retval = $query_parser->parse($query_string);
-my $retval = $query_parser->parse(); # default: undef</pre>
+<pre>my $query = $query_parser->parse($query_string);
+my $query = $query_parser->parse(); # default: undef</pre>
<p>Build a Query object from the contents of a query string.
At present,
@@ -130,7 +130,7 @@ May be undef.</li>
name="tree"
>tree</a></h3>
-<pre>my $retval = $query_parser->tree($query_string);</pre>
+<pre>my $query = $query_parser->tree($query_string);</pre>
<p>Parse the logical structure of a query string,
building a tree comprised of Query objects.
@@ -154,7 +154,7 @@ and RequiredOptionalQuery.</p>
name="expand"
>expand</a></h3>
-<pre>my $retval = $query_parser->expand($query);</pre>
+<pre>my $query = $query_parser->expand($query);</pre>
<p>Walk the hierarchy of a Query tree,
descending through all PolyQuery nodes and calling <a href="#expand_leaf" class="podlinkpod"
@@ -171,7 +171,7 @@ but possibly another.</p>
name="expand_leaf"
>expand_leaf</a></h3>
-<pre>my $retval = $query_parser->expand_leaf($query);</pre>
+<pre>my $query = $query_parser->expand_leaf($query);</pre>
<p>Convert a LeafQuery into either a TermQuery,
a PhraseQuery,
@@ -191,8 +191,8 @@ Only LeafQuery objects will be processed
name="prune"
>prune</a></h3>
-<pre>my $retval = $query_parser->prune($query);
-my $retval = $query_parser->prune(); # default: undef</pre>
+<pre>my $query = $query_parser->prune($query);
+my $query = $query_parser->prune(); # default: undef</pre>
<p>Prevent certain Query structures from returning too many results.
Query objects built via <a href="#tree" class="podlinkpod"
@@ -230,7 +230,7 @@ the supplied Query after in-place modifi
name="make_term_query"
>make_term_query</a></h3>
-<pre>my $retval = $query_parser->make_term_query(
+<pre>my $query = $query_parser->make_term_query(
field => $field # required
term => $term # required
);</pre>
@@ -249,7 +249,7 @@ name="make_term_query"
name="make_phrase_query"
>make_phrase_query</a></h3>
-<pre>my $retval = $query_parser->make_phrase_query(
+<pre>my $query = $query_parser->make_phrase_query(
field => $field # required
terms => $terms # required
);</pre>
@@ -268,8 +268,8 @@ name="make_phrase_query"
name="make_or_query"
>make_or_query</a></h3>
-<pre>my $retval = $query_parser->make_or_query($children);
-my $retval = $query_parser->make_or_query(); # default: undef</pre>
+<pre>my $query = $query_parser->make_or_query($children);
+my $query = $query_parser->make_or_query(); # default: undef</pre>
<p>Factory method creating an ORQuery.</p>
@@ -283,8 +283,8 @@ my $retval = $query_parser->make_or_
name="make_and_query"
>make_and_query</a></h3>
-<pre>my $retval = $query_parser->make_and_query($children);
-my $retval = $query_parser->make_and_query(); # default: undef</pre>
+<pre>my $query = $query_parser->make_and_query($children);
+my $query = $query_parser->make_and_query(); # default: undef</pre>
<p>Factory method creating an ANDQuery.</p>
@@ -298,7 +298,7 @@ my $retval = $query_parser->make_and
name="make_not_query"
>make_not_query</a></h3>
-<pre>my $retval = $query_parser->make_not_query($negated_query);</pre>
+<pre>my $query = $query_parser->make_not_query($negated_query);</pre>
<p>Factory method creating a NOTQuery.</p>
@@ -312,7 +312,7 @@ name="make_not_query"
name="make_req_opt_query"
>make_req_opt_query</a></h3>
-<pre>my $retval = $query_parser->make_req_opt_query(
+<pre>my $query = $query_parser->make_req_opt_query(
required_query => $required_query # required
optional_query => $optional_query # required
);</pre>
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/RangeQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/RangeQuery.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/RangeQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/RangeQuery.mdtext Sat Feb 27 15:04:44 2016
@@ -80,7 +80,7 @@ name="METHODS"
name="make_compiler"
>make_compiler</a></h3>
-<pre>my $retval = $range_query->make_compiler(
+<pre>my $compiler = $range_query->make_compiler(
searcher => $searcher # required
boost => $boost # required
subordinate => $subordinate # default: false
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/RequiredOptionalQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/RequiredOptionalQuery.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/RequiredOptionalQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/RequiredOptionalQuery.mdtext Sat Feb 27 15:04:44 2016
@@ -61,7 +61,7 @@ name="METHODS"
name="get_required_query"
>get_required_query</a></h3>
-<pre>my $retval = $required_optional_query->get_required_query();</pre>
+<pre>my $query = $required_optional_query->get_required_query();</pre>
<p>Getter for the required Query.</p>
@@ -77,7 +77,7 @@ name="set_required_query"
name="get_optional_query"
>get_optional_query</a></h3>
-<pre>my $retval = $required_optional_query->get_optional_query();</pre>
+<pre>my $query = $required_optional_query->get_optional_query();</pre>
<p>Getter for the optional Query.</p>
@@ -93,7 +93,7 @@ name="set_optional_query"
name="make_compiler"
>make_compiler</a></h3>
-<pre>my $retval = $required_optional_query->make_compiler(
+<pre>my $compiler = $required_optional_query->make_compiler(
searcher => $searcher # required
boost => $boost # required
subordinate => $subordinate # default: false
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/Searcher.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/Searcher.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/Searcher.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/Searcher.mdtext Sat Feb 27 15:04:44 2016
@@ -54,7 +54,7 @@ name="ABSTRACT_METHODS"
name="doc_max"
>doc_max</a></h3>
-<pre>my $retval = $searcher->doc_max();</pre>
+<pre>my $int = $searcher->doc_max();</pre>
<p>Return the maximum number of docs in the collection represented by the Searcher,
which is also the highest possible internal doc id.
@@ -64,7 +64,7 @@ Documents which have been marked as dele
name="doc_freq"
>doc_freq</a></h3>
-<pre>my $retval = $searcher->doc_freq(
+<pre>my $int = $searcher->doc_freq(
field => $field # required
term => $term # required
);</pre>
@@ -100,7 +100,7 @@ feeding them into a <a href="../../Lucy/
name="fetch_doc"
>fetch_doc</a></h3>
-<pre>my $retval = $searcher->fetch_doc($doc_id);</pre>
+<pre>my $hit_doc = $searcher->fetch_doc($doc_id);</pre>
<p>Retrieve a document.
Throws an error if the doc id is out of range.</p>
@@ -117,8 +117,8 @@ name="METHODS"
name="glean_query"
>glean_query</a></h3>
-<pre>my $retval = $searcher->glean_query($query);
-my $retval = $searcher->glean_query(); # default: undef</pre>
+<pre>my $query = $searcher->glean_query($query);
+my $query = $searcher->glean_query(); # default: undef</pre>
<p>If the supplied object is a Query,
return it; if it’s a query string,
@@ -128,7 +128,7 @@ create a QueryParser and parse it to pro
name="hits"
>hits</a></h3>
-<pre>my $retval = $searcher->hits(
+<pre>my $hits = $searcher->hits(
query => $query # required
offset => $offset # default: 0
num_wanted => $num_wanted # default: 10
@@ -156,7 +156,7 @@ which will affect how results are ranked
name="get_schema"
>get_schema</a></h3>
-<pre>my $retval = $searcher->get_schema();</pre>
+<pre>my $schema = $searcher->get_schema();</pre>
<p>Accessor for the object’s <code>schema</code> member.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/SortRule.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/SortRule.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/SortRule.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/SortRule.mdtext Sat Feb 27 15:04:44 2016
@@ -67,7 +67,7 @@ name="METHODS"
name="get_field"
>get_field</a></h3>
-<pre>my $retval = $sort_rule->get_field();</pre>
+<pre>my $string = $sort_rule->get_field();</pre>
<p>Accessor for “field” member.</p>
@@ -75,7 +75,7 @@ name="get_field"
name="get_type"
>get_type</a></h3>
-<pre>my $retval = $sort_rule->get_type();</pre>
+<pre>my $int = $sort_rule->get_type();</pre>
<p>Accessor for “type” member.</p>
@@ -83,7 +83,7 @@ name="get_type"
name="get_reverse"
>get_reverse</a></h3>
-<pre>my $retval = $sort_rule->get_reverse();</pre>
+<pre>my $bool = $sort_rule->get_reverse();</pre>
<p>Accessor for “reverse” member.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/Span.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/Span.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/Span.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/Span.mdtext Sat Feb 27 15:04:44 2016
@@ -70,7 +70,7 @@ name="METHODS"
name="get_offset"
>get_offset</a></h3>
-<pre>my $retval = $span->get_offset();</pre>
+<pre>my $int = $span->get_offset();</pre>
<p>Accessor for <code>offset</code> attribute.</p>
@@ -86,7 +86,7 @@ name="set_offset"
name="get_length"
>get_length</a></h3>
-<pre>my $retval = $span->get_length();</pre>
+<pre>my $int = $span->get_length();</pre>
<p>Accessor for <code>length</code> attribute.</p>
@@ -102,7 +102,7 @@ name="set_length"
name="get_weight"
>get_weight</a></h3>
-<pre>my $retval = $span->get_weight();</pre>
+<pre>my $float = $span->get_weight();</pre>
<p>Accessor for <code>weight</code> attribute.</p>
@@ -118,7 +118,7 @@ name="set_weight"
name="compare_to"
>compare_to</a></h3>
-<pre>my $retval = $span->compare_to($other);</pre>
+<pre>my $int = $span->compare_to($other);</pre>
<p>Indicate whether one object is less than,
equal to,
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/TermQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/TermQuery.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/TermQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/TermQuery.mdtext Sat Feb 27 15:04:44 2016
@@ -55,7 +55,7 @@ name="METHODS"
name="get_field"
>get_field</a></h3>
-<pre>my $retval = $term_query->get_field();</pre>
+<pre>my $string = $term_query->get_field();</pre>
<p>Accessor for object’s <code>field</code> member.</p>
@@ -63,7 +63,7 @@ name="get_field"
name="get_term"
>get_term</a></h3>
-<pre>my $retval = $term_query->get_term();</pre>
+<pre>my $obj = $term_query->get_term();</pre>
<p>Accessor for object’s <code>term</code> member.</p>
@@ -71,7 +71,7 @@ name="get_term"
name="make_compiler"
>make_compiler</a></h3>
-<pre>my $retval = $term_query->make_compiler(
+<pre>my $compiler = $term_query->make_compiler(
searcher => $searcher # required
boost => $boost # required
subordinate => $subordinate # default: false
Modified: lucy/site/trunk/content/docs/test/Lucy/Simple.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Simple.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Simple.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Simple.mdtext Sat Feb 27 15:04:44 2016
@@ -114,7 +114,7 @@ with field names as keys and content as
name="search"
>search</a></h3>
-<pre>my $retval = $simple->search(
+<pre>my $int = $simple->search(
query => $query # required
offset => $offset # default: 0
num_wanted => $num_wanted # default: 10
@@ -139,7 +139,7 @@ assuming that 30 hits can be found.</li>
name="next"
>next</a></h3>
-<pre>my $retval = $simple->next();</pre>
+<pre>my $hit_doc = $simple->next();</pre>
<p>Return the next hit,
or undef when the iterator is exhausted.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Store/Lock.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Store/Lock.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Store/Lock.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Store/Lock.mdtext Sat Feb 27 15:04:44 2016
@@ -72,7 +72,7 @@ name="ABSTRACT_METHODS"
name="shared"
>shared</a></h3>
-<pre>my $retval = $lock->shared();</pre>
+<pre>my $bool = $lock->shared();</pre>
<p>Returns true if the Lock is shared,
false if the Lock is exclusive.</p>
@@ -81,7 +81,7 @@ false if the Lock is exclusive.</p>
name="request"
>request</a></h3>
-<pre>my $retval = $lock->request();</pre>
+<pre>my $bool = $lock->request();</pre>
<p>Make one attempt to acquire the lock.</p>
@@ -112,7 +112,7 @@ name="release"
name="is_locked"
>is_locked</a></h3>
-<pre>my $retval = $lock->is_locked();</pre>
+<pre>my $bool = $lock->is_locked();</pre>
<p>Indicate whether the resource identified by this lock’s name is currently locked.</p>
@@ -137,7 +137,7 @@ name="METHODS"
name="obtain"
>obtain</a></h3>
-<pre>my $retval = $lock->obtain();</pre>
+<pre>my $bool = $lock->obtain();</pre>
<p>Call <a href="#request" class="podlinkpod"
>request()</a> once per <code>interval</code> until <a href="#request" class="podlinkpod"
Modified: lucy/site/trunk/content/docs/test/Lucy/Store/LockFactory.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Store/LockFactory.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Store/LockFactory.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Store/LockFactory.mdtext Sat Feb 27 15:04:44 2016
@@ -66,7 +66,7 @@ name="METHODS"
name="make_lock"
>make_lock</a></h3>
-<pre>my $retval = $lock_factory->make_lock(
+<pre>my $lock = $lock_factory->make_lock(
name => $name # required
timeout => $timeout # default: 0
interval => $interval # default: 100
@@ -91,7 +91,7 @@ maintains an exclusive lock on a resourc
name="make_shared_lock"
>make_shared_lock</a></h3>
-<pre>my $retval = $lock_factory->make_shared_lock(
+<pre>my $lock = $lock_factory->make_shared_lock(
name => $name # required
timeout => $timeout # default: 0
interval => $interval # default: 100
Modified: lucy/site/trunk/content/docs/test/LucyX/Search/ProximityQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/LucyX/Search/ProximityQuery.mdtext?rev=1732649&r1=1732648&r2=1732649&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/LucyX/Search/ProximityQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/LucyX/Search/ProximityQuery.mdtext Sat Feb 27 15:04:44 2016
@@ -57,7 +57,7 @@ name="METHODS"
name="get_field"
>get_field</a></h3>
-<pre>my $retval = $proximity_query->get_field();</pre>
+<pre>my $string = $proximity_query->get_field();</pre>
<p>Accessor for object’s field attribute.</p>
@@ -65,7 +65,7 @@ name="get_field"
name="get_terms"
>get_terms</a></h3>
-<pre>my $retval = $proximity_query->get_terms();</pre>
+<pre>my $arrayref = $proximity_query->get_terms();</pre>
<p>Accessor for object’s array of terms.</p>
@@ -73,7 +73,7 @@ name="get_terms"
name="get_within"
>get_within</a></h3>
-<pre>my $retval = $proximity_query->get_within();</pre>
+<pre>my $int = $proximity_query->get_within();</pre>
<p>Accessor for object’s within attribute.</p>
@@ -81,7 +81,7 @@ name="get_within"
name="make_compiler"
>make_compiler</a></h3>
-<pre>my $retval = $proximity_query->make_compiler(
+<pre>my $compiler = $proximity_query->make_compiler(
searcher => $searcher # required
boost => $boost # required
subordinate => $subordinate # default: false