Issue #2369675 by FMB, pstewart, jhodgdon: Document that SearchQuery does not support orderBy in queries outside of addScore

1 files changed, 4 insertions, 4 deletions

diff --git a/modules/search/search.extender.inc b/modules/search/search.extender.inc
index 72cea6472..407425696 100644
--- a/modules/search/search.extender.inc
+++ b/modules/search/search.extender.inc
@@ -409,10 +409,10 @@ class SearchQuery extends SelectQueryExtender {
    * used. However, if at least one call to addScore() has taken place, the
    * keyword relevance score is not automatically added.
    *
-   * Also note that if you call orderBy() directly on the query, search scores
-   * will not automatically be used to order search results. Your orderBy()
-   * expression can reference 'calculated_score', which will be the total
-   * calculated score value.
+   * Note that you must use this method to add ordering to your searches, and
+   * not call orderBy() directly, when using the SearchQuery extender. This is
+   * because of the two-pass system the SearchQuery class uses to normalize
+   * scores.
    *
    * @param $score
    *   The score expression, which should evaluate to a number between 0 and 1.