svn commit: r911877 - /lucene/solr/trunk/src/java/org/apache/solr/search/function/ValueSource.java

[yo...@apache.org]

Author: yonik
Date: Fri Feb 19 17:55:07 2010
New Revision: 911877

URL: http://svn.apache.org/viewvc?rev=911877&view=rev
Log:
doc: warn about sorting by function

Modified:
    lucene/solr/trunk/src/java/org/apache/solr/search/function/ValueSource.java

Modified: lucene/solr/trunk/src/java/org/apache/solr/search/function/ValueSource.java
URL: http://svn.apache.org/viewvc/lucene/solr/trunk/src/java/org/apache/solr/search/function/ValueSource.java?rev=911877&r1=911876&r2=911877&view=diff
==============================================================================
--- lucene/solr/trunk/src/java/org/apache/solr/search/function/ValueSource.java (original)
+++ lucene/solr/trunk/src/java/org/apache/solr/search/function/ValueSource.java Fri Feb 19 17:55:07 2010
@@ -68,10 +68,13 @@
   }
 
   /**
+   * EXPERIMENTAL: This method is subject to change.
+   * <br>WARNING: Sorted function queries are not currently weighted.
+   * <p>
    * Get the SortField for this ValueSource.  Uses the {@link #getValues(java.util.Map, org.apache.lucene.index.IndexReader)}
    * to populate the SortField.
    * 
-   * @param reverse true if the order should be reversed.
+   * @param reverse true if this is a reverse sort.
    * @return The {@link org.apache.lucene.search.SortField} for the ValueSource
    * @throws IOException if there was a problem reading the values.
    */