This repository was archived by the owner on Nov 1, 2017. It is now read-only.
- Notifications
You must be signed in to change notification settings - Fork1.1k
Add explanation for score field for search results#456
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
2 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
8 changes: 8 additions & 0 deletionscontent/v3/search.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| 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 | ||
| satisfy that need, the GitHub Search API provides **up to 1,000 results for each | ||
| search**. | ||
Contributor There was a problem hiding this comment. Choose a reason for hiding this commentThe 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"? ContributorAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I can dig it. Added in6e978ac. | ||
| ### 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 | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.