Sync changes from upstream repository

Hubot · Hubot · commit 1699d5e9c9e5 · 2015-08-31T08:00:58.000Z
diff --git a/content/changes/2013-04-25-deprecating-merge-commit-sha.html b/content/changes/2013-04-25-deprecating-merge-commit-sha.html
@@ -13,7 +13,7 @@
 confusion.
 
 To help current API consumers, we've [documented the
-attribute](/v3/pulls/#mergability) for improved understanding.
+attribute](/v3/pulls/#get-a-single-pull-request) for improved understanding.
 
 To protect future API consumers from this confusion, we have
 [deprecated](/v3/versions/#v3-deprecations) the `merge_commit_sha` attribute, and we will
diff --git a/content/v3/git/trees.md b/content/v3/git/trees.md
@@ -13,31 +13,30 @@ title: Git Trees | GitHub API
 
 ### Response
 
-<%= headers 200 %>
-<%= json :tree %>
-
 {{#tip}}
 
 If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.
 
 {{/tip}}
 
+<%= headers 200 %>
+<%= json :tree %>
+
 ## Get a Tree Recursively
 
     GET /repos/:owner/:repo/git/trees/:sha?recursive=1
 
 ### Response
 
-<%= headers 200 %>
-<%= json :tree_extra %>
-
-
 {{#tip}}
 
 If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
 
 {{/tip}}
 
+<%= headers 200 %>
+<%= json :tree_extra %>
+
 ## Create a Tree
 
 The tree creation API will take nested entries as well. If both a
diff --git a/content/v3/pulls.md b/content/v3/pulls.md
@@ -44,7 +44,6 @@ Name | Type | Description
 `sort`|`string`|  What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). Default: `created`
 `direction`|`string`| The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.
 
-
 ### Response
 
 <%= headers 200, :pagination => default_pagination_rels %>
@@ -56,10 +55,7 @@ Name | Type | Description
 
 ### Response
 
-<%= headers 200 %>
-<%= json :full_pull %>
-
-### Mergability
+{{#tip}}
 
 Each time the pull request receives new commits, GitHub creates a merge commit
 to _test_ whether the pull request can be automatically merged into the base
@@ -69,16 +65,19 @@ however, this attribute is [deprecated](/v3/versions/#v3-deprecations) and is sc
 removal in the next version of the API. The Boolean `mergeable` attribute will
 remain to indicate whether the pull request can be automatically merged.
 
-The value of the `mergeable` attribute can be `true`, `false`, or `null`. If 
+The value of the `mergeable` attribute can be `true`, `false`, or `null`. If
 the value is `null`, this means that the mergeability hasn't been computed yet,
 and a background job was started to compute it. Give the job a few moments to
 complete, and then submit the request again. When the job is complete, the
 response will include a non-`null` value for the `mergeable` attribute.
 
-### Alternative Response Formats
+{{/tip}}
 
 Pass the appropriate [media type](/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
 
+<%= headers 200 %>
+<%= json :full_pull %>
+
 ## Create a pull request
 
     POST /repos/:owner/:repo/pulls
diff --git a/content/v3/repos/commits.md b/content/v3/repos/commits.md
@@ -37,13 +37,13 @@ Name | Type | Description
 
 ### Response
 
-<%= headers 200 %>
-<%= json(:full_commit) %>
-
-Note: Diffs with binary data will have no 'patch' property. Pass the
+Diffs with binary data will have no 'patch' property. Pass the
 appropriate [media type](/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and
 patch formats.
 
+<%= headers 200 %>
+<%= json(:full_commit) %>
+
 ## Compare two commits
 
     GET /repos/:owner/:repo/compare/:base...:head
@@ -56,10 +56,10 @@ Both `:base` and `:head` must be branch names in `:repo`. To compare branches ac
 
 The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in reverse chronological order.
 
-<%= json :commit_comparison %>
-
 Pass the appropriate [media type](/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
 
+<%= json :commit_comparison %>
+
 ### Working with large comparisons
 
 The response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [Commit List API](/v3/repos/commits/#list-commits-on-a-repository) to enumerate all commits in the range.
diff --git a/content/v3/repos/contents.md b/content/v3/repos/contents.md
@@ -64,14 +64,14 @@ Name | Type | Description
 
 The response will be an array of objects, one object for each item in the directory.
 
-<%= headers 200 %>
-<%= json :directory_content %>
-
-Note: When listing the contents of a directory, submodules have their "type"
+When listing the contents of a directory, submodules have their "type"
 specified as "file". Logically, the value *should* be "submodule". This behavior
 exists in API v3 [for backwards compatibility purposes](https://github.com/github/developer.github.com/commit/1b329b04cece9f3087faa7b1e0382317a9b93490).
 In the next major version of the API, the type will be returned as "submodule".
 
+<%= headers 200 %>
+<%= json :directory_content %>
+
 ### Response if content is a symlink
 
 If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the [format shown above](#response-if-content-is-a-file)).
@@ -83,14 +83,14 @@ Otherwise, the API responds with an object describing the symlink itself:
 
 ### Response if content is a submodule
 
-<%= headers 200 %>
-<%= json :submodule_content %>
-
 The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository.
 Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit.
 
 If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values.
 
+<%= headers 200 %>
+<%= json :submodule_content %>
+
 ## Create a file
 
 This method creates a new file in a repository
diff --git a/content/v3/repos/releases.md b/content/v3/repos/releases.md
@@ -195,15 +195,17 @@ This may leave an empty asset with a state of `"new"`.  It can be safely deleted
 
 ### Response
 
-<%= headers 200 %>
-<%= json :release_asset %>
+{{#tip}}
 
 If you want to download the asset's binary content, pass a media type of
-`"application/octet-stream"`.  The API will either redirect the client to the
+`"application/octet-stream"`. The API will either redirect the client to the
 location, or stream it directly if possible.  API clients should handle both a
 `200` or `302` response.
 
-<%= headers 302 %>
+{{/tip}}
+
+<%= headers 200 %>
+<%= json :release_asset %>
 
 ## Edit a release asset
 
diff --git a/content/v3/repos/statistics.md b/content/v3/repos/statistics.md
@@ -28,18 +28,17 @@ which is usually master; pushing to the default branch resets the statistics cac
 
 ### Response
 
-<%= headers 200 %>
-<%= json(:repo_stats_contributors) %>
-
 * `total` - The Total number of commits authored by the contributor.
 
-**Weekly Hash**
+Weekly Hash (`weeks` array):
 
 * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).
 * `a` - Number of additions
 * `d` - Number of deletions
 * `c` - Number of commits
 
+<%= headers 200 %>
+<%= json(:repo_stats_contributors) %>
 
 ## Get the last year of commit activity data {#commit-activity}
 
diff --git a/content/v3/users.md b/content/v3/users.md
@@ -19,12 +19,12 @@ information](/v3/#authentication) with your request).
 
 ### Response
 
-<%= headers 200 %>
-<%= json :full_user %>
-
 Note: The returned email is the user's publicly visible email address
 (or `null` if the user has not [specified a public email address in their profile](https://github.com/settings/profile)).
 
+<%= headers 200 %>
+<%= json :full_user %>
+
 ## Get the authenticated user
 
     GET /user
