Skip to content
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Add explanation for score field for search results #456

Merged
pengwynn merged 2 commits into from
Mar 14, 2014
Merged

Add explanation for score field for search results #456

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91f431f
Add explanation for score field for search results
pengwynn Mar 14, 2014
6e978ac
Add heading for ranking search results
pengwynn Mar 14, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions content/v3/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**.

Copy link
Contributor

@jasonrudolph jasonrudolph Mar 14, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would you think about adding a section heading? That would make this paragraph easier to spot for people that are skimming through the docs, and it would provide a way to link directly to this explanation.

Perhaps: "Scoring Search Results" or "Ranking Search Results"?

Copy link
Contributor Author

@pengwynn pengwynn Mar 14, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can dig it. Added in 6e978ac.

### 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
Expand Down