Commit d00a5db
Sync changes from upstream repository
1 parent 95cb996 commit d00a5db
2 files changed
Lines changed: 26 additions & 11 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -126,6 +126,16 @@ Find file contents via various criteria. (This method returns up to 100 results | |||
| 126 | 126 | ||
| 127 | 127 | GET /search/code | |
| 128 | 128 | ||
| 129 | + ### Considerations for code search | ||
| 130 | + | ||
| 131 | + Due to the complexity of searching code, there are a few restrictions on how searches are performed: | ||
| 132 | + | ||
| 133 | + <ul> | ||
| 134 | + <li>Only the _default branch_ is considered. In most cases, this will be the `master` branch.</li> | ||
| 135 | + <li>Only files smaller than 200 KB are searchable.</li> | ||
| 136 | + <li class='not-enterprise'> You must always include at least one search term when searching source code. For example, searching for <a href="https://github.com/search?utf8=✓&q=language%3Ago&type=Code"><code>language:go</code></a> is not valid, while <a href="https://github.com/search?utf8=✓&q=amazing+language%3Ago&type=Code"><code>amazing language:go</code></a> is.</li> | ||
| 137 | + </ul> | ||
| 138 | + | ||
| 129 | 139 | ### Parameters | |
| 130 | 140 | ||
| 131 | 141 | Name | Type | Description | |
@@ -217,34 +227,36 @@ The `q` search term can also contain any combination of the supported issue sear | |||
| 217 | 227 | Qualifies which fields are searched. With this qualifier you can restrict the | |
| 218 | 228 | search to just the title, body, comments, or any combination of these. | |
| 219 | 229 | * [`author`](https://help.github.com/articles/searching-issues#search-by-the-author-of-an-issue-or-pull-request) | |
| 220 | - Finds issues created by a certain user. | ||
| 230 | + Finds issues or pull requests created by a certain user. | ||
| 221 | 231 | * [`assignee`](https://help.github.com/articles/searching-issues#search-by-the-assignee-of-an-issue-or-pull-request) | |
| 222 | - Finds issues that are assigned to a certain user. | ||
| 232 | + Finds issues or pull requests that are assigned to a certain user. | ||
| 223 | 233 | * [`mentions`](https://help.github.com/articles/searching-issues#search-by-a-mentioned-user-within-an-issue-or-pull-request) | |
| 224 | - Finds issues that mention a certain user. | ||
| 234 | + Finds issues or pull requests that mention a certain user. | ||
| 225 | 235 | * [`commenter`](https://help.github.com/articles/searching-issues#search-by-a-commenter-within-an-issue-or-pull-request) | |
| 226 | - Finds issues that a certain user commented on. | ||
| 236 | + Finds issues or pull requests that a certain user commented on. | ||
| 227 | 237 | * [`involves`](https://help.github.com/articles/searching-issues#search-by-a-user-thats-involved-within-an-issue-or-pull-request) | |
| 228 | - Finds issues that were either created by a certain user, assigned to that | ||
| 238 | + Finds issues or pull requests that were either created by a certain user, assigned to that | ||
| 229 | 239 | user, mention that user, or were commented on by that user. | |
| 240 | + * [`team`](https://help.github.com/articles/searching-issues/#search-by-a-team-thats-mentioned-within-an-issue-or-pull-request) | ||
| 241 | + For organizations you're a member of, finds issues or pull requests that @mention a team within the organization. | ||
| 230 | 242 | * [`state`](https://help.github.com/articles/searching-issues#search-based-on-whether-an-issue-or-pull-request-is-open) | |
| 231 | - Filter issues based on whether they're open or closed. | ||
| 243 | + Filter issues or pull requests based on whether they're open or closed. | ||
| 232 | 244 | * [`labels`](https://help.github.com/articles/searching-issues#search-by-the-labels-on-an-issue) | |
| 233 | - Filters issues based on their labels. | ||
| 245 | + Filters issues or pull requests based on their labels. | ||
| 234 | 246 | * [`no`](https://help.github.com/articles/searching-issues#search-by-missing-metadata-on-an-issue-or-pull-request) | |
| 235 | 247 | Filters items missing certain metadata, such as `label`, `milestone`, or `assignee` | |
| 236 | 248 | * [`language`](https://help.github.com/articles/searching-issues#search-by-the-main-language-of-a-repository) | |
| 237 | - Searches for issues within repositories that match a certain language. | ||
| 249 | + Searches for issues or pull requests within repositories that match a certain language. | ||
| 238 | 250 | * [`is`](https://help.github.com/articles/searching-issues#search-based-on-the-state-of-an-issue-or-pull-request) | |
| 239 | 251 | Searches for items within repositories that match a certain state, such as `open`, `closed`, or `merged` | |
| 240 | 252 | * [`created` or `updated`](https://help.github.com/articles/searching-issues#search-based-on-when-an-issue-or-pull-request-was-created-or-last-updated) | |
| 241 | - Filters issues based on date of creation, or when they were last updated. | ||
| 253 | + Filters issues or pull requests based on date of creation, or when they were last updated. | ||
| 242 | 254 | * [`merged`](https://help.github.com/articles/searching-issues#search-based-on-when-a-pull-request-was-merged) | |
| 243 | 255 | Filters pull requests based on the date when they were merged. | |
| 244 | 256 | * [`closed`](https://help.github.com/articles/searching-issues#search-based-on-when-an-issue-or-pull-request-was-closed) | |
| 245 | - Filters issues based on the date when they were closed. | ||
| 257 | + Filters issues or pull requests based on the date when they were closed. | ||
| 246 | 258 | * [`comments`](https://help.github.com/articles/searching-issues#search-by-the-number-of-comments-an-issue-or-pull-request-has) | |
| 247 | - Filters issues based on the quantity of comments. | ||
| 259 | + Filters issues or pull requests based on the quantity of comments. | ||
| 248 | 260 | * [`user` or `repo`](https://help.github.com/articles/searching-issues#search-within-a-users-or-organizations-repositories) | |
| 249 | 261 | Limits searches to a specific user or repository. | |
| 250 | 262 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -39,6 +39,9 @@ begin | |||
| 39 | 39 | doc.css('img').each do |img| | |
| 40 | 40 | img['src'] = "/enterprise/#{version}#{img['src']}" if img['src'] =~ /^\// | |
| 41 | 41 | end | |
| 42 | + doc.css('.not-enterprise').each do |non_ent| | ||
| 43 | + non_ent.remove | ||
| 44 | + end | ||
| 42 | 45 | File.open(html_file, 'w') { |file| file.write(doc.to_html) } | |
| 43 | 46 | end | |
| 44 | 47 | ||
0 commit comments