Merge pull request #456 from github/doc-score-field

pengwynn · pengwynn · commit 3eb05f425790 · 2014-03-14T12:39:42.000-05:00
Add explanation for score field for search results
diff --git a/content/v3/search.md b/content/v3/search.md
@@ -18,6 +18,14 @@ search results so that you can find the item that best meets your needs. To
 satisfy that need, the GitHub Search API provides **up to 1,000 results for each
 search**.
 
+### Ranking search results
+
+Unless another sort option is provided as a query parameter, results are sorted
+by best match, as indicated by the `score` field for each item returned. This
+is a computed value representing the relevance of a item relative to the other
+items in the result set. Multiple factors are combined to boost the most
+relevant item to the top of the result list.
+
 ### Rate limit
 
 The Search API has a custom rate limit. For requests using [Basic
