Commit3eb05f4

committed

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

Add explanation for score field for search results

2 parentsa9c328b +6e978ac commit3eb05f4Copy full SHA for 3eb05f4

File tree

-0

lines changed

-0

lines changed

Lines changed: 8 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,14 @@ search results so that you can find the item that best meets your needs. To`
`18`	`18`	`satisfy that need, the GitHub Search API provides**up to 1,000 results for each`
`19`	`19`	`search**.`
`20`	`20`
	`21`	`+###Ranking search results`
	`22`	`+`
	`23`	`+Unless another sort option is provided as a query parameter, results are sorted`
	`24`	+by best match, as indicated by the`score` field for each item returned. This
	`25`	`+is a computed value representing the relevance of a item relative to the other`
	`26`	`+items in the result set. Multiple factors are combined to boost the most`
	`27`	`+relevant item to the top of the result list.`
	`28`	`+`
`21`	`29`	`###Rate limit`
`22`	`30`
`23`	`31`	`The Search API has a custom rate limit. For requests using[Basic`

Comments

(0)