Skip to content

Commit 68ebea7

Browse files
committed
Make search syntax documentation more obvious
It wasn't immediately clear that the qualifiers on the Search API page are links to further documentation. Links to the two in-browser search syntax documents have been added. The `forks` qualifiers was also separated from the `fork` qualifier as described on the search doc page.
1 parent 061b886 commit 68ebea7

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

content/v3/search.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Name | Type | Description
6161
`sort`|`string`| The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.
6262
`order`|`string`| The sort order if `sort` parameter is provided. One of `asc` or `desc`. Default: `desc`
6363

64-
The `q` search term can also contain any combination of the supported repository search qualifiers:
64+
The `q` search term can also contain any combination of the supported repository search qualifiers as described by the in-browser [repository search documentation](https://help.github.com/articles/searching-repositories/) and [search syntax documentation](https://help.github.com/articles/search-syntax/):
6565

6666
* [`in`](https://help.github.com/articles/searching-repositories#scope-the-search-fields)
6767
Qualifies which fields are searched. With this qualifier you can restrict the
@@ -70,7 +70,8 @@ The `q` search term can also contain any combination of the supported repository
7070
* [`size`](https://help.github.com/articles/searching-repositories#search-based-on-the-size-of-a-repository)
7171
Finds repositories that match a certain size (in kilobytes).
7272
* [`forks`](https://help.github.com/articles/searching-repositories#search-based-on-the-number-of-forks-the-parent-repository-has)
73-
Filters repositories based on the number of forks, and/or whether forked repositories should be included in the results at all.
73+
Filters repositories based on the number of forks
74+
* [`fork`](https://help.github.com/articles/searching-repositories#search-based-on-the-number-of-forks-the-parent-repository-has) Filters whether forked repositories should be included (`true`) or only forked repositories should be returned (`only`).
7475
* [`created` or `pushed`](https://help.github.com/articles/searching-repositories#search-based-on-when-a-repository-was-created-or-last-updated)
7576
Filters repositories based on date of creation, or when they were last updated.
7677
* [`user` or `repo`](https://help.github.com/articles/searching-repositories#search-within-a-users-or-organizations-repositories)

0 commit comments

Comments
 (0)