Skip to content

Commit cff773a

Browse files
gjtorikiangjtorikian
committed
Drop the Default column
This standerdizes on adding the text `Default: ` to the end of the description. It saves us horionztal space, and omits a lot of empty Default columns
1 parent aa0a970 commit cff773a

33 files changed

Lines changed: 476 additions & 476 deletions

‎content/v3/activity/notifications.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ List all notifications for the current user, grouped by repository.
5757

5858
### Parameters
5959

60-
Name | Type | Description | Default
61-
----|------|--------------|---------
62-
`all`|`boolean` | If `true`, show notifications marked as read.|`false`
63-
`participating`|`boolean` | If `true`, only shows notifications in which the user is directly participating or mentioned.|`false`
64-
`since`|`string` | Filters out any notifications updated before the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
60+
Name | Type | Description
61+
-----|------|--------------
62+
`all`|`boolean` | If `true`, show notifications marked as read. Default: `false`
63+
`participating`|`boolean` | If `true`, only shows notifications in which the user is directly participating or mentioned. Default: `false`
64+
`since`|`string` | Filters out any notifications updated before the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Default: `Time.now`
6565

6666

6767
### Response
@@ -77,11 +77,11 @@ List all notifications for the current user.
7777

7878
### Parameters
7979

80-
Name | Type | Description | Default
81-
----|------|--------------|---------
82-
`all`|`boolean` | If `true`, show notifications marked as read.|`false`
83-
`participating`|`boolean` | If `true`, only shows notifications in which the user is directly participating or mentioned.|`false`
84-
`since`|`string` | Filters out any notifications updated before the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
80+
Name | Type | Description
81+
-----|------|--------------
82+
`all`|`boolean` | If `true`, show notifications marked as read. Default: `false`
83+
`participating`|`boolean` | If `true`, only shows notifications in which the user is directly participating or mentioned. Default: `false`
84+
`since`|`string` | Filters out any notifications updated before the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Default: `Time.now`
8585

8686

8787
### Response
@@ -98,9 +98,9 @@ on GitHub.com](https://github.com/notifications).
9898

9999
### Parameters
100100

101-
Name | Type | Description | Default
102-
----|------|--------------|---------
103-
`last_read_at`|`string` | Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.| Now.
101+
Name | Type | Description
102+
-----|------|--------------
103+
`last_read_at`|`string` | Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Default: `Time.now`
104104

105105

106106
### Response
@@ -116,9 +116,9 @@ from the [default view on GitHub.com](https://github.com/notifications).
116116

117117
### Parameters
118118

119-
Name | Type | Description | Default
120-
----|------|--------------|---------
121-
`last_read_at`|`string` | Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|Now.
119+
Name | Type | Description
120+
-----|------|--------------
121+
`last_read_at`|`string` | Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Default: `Time.now`
122122

123123

124124
### Response
@@ -165,10 +165,10 @@ a thread will mute all future notifications (until you comment or get
165165

166166
### Parameters
167167

168-
Name | Type | Description | Default
169-
----|------|--------------|---------
170-
`subscribed`|`boolean`| Determines if notifications should be received from this thread|
171-
`ignored`|`boolean`| Determines if all notifications should be blocked from this thread|
168+
Name | Type | Description
169+
-----|------|--------------
170+
`subscribed`|`boolean`| Determines if notifications should be received from this thread
171+
`ignored`|`boolean`| Determines if all notifications should be blocked from this thread
172172

173173

174174
### Response

‎content/v3/activity/settings.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ Update the notification settings for the authenticated user.
1919

2020
### Parameters
2121

22-
Name | Type | Description | Default
23-
----|------|--------------|---------
24-
`participating.email`|`boolean` | `true` to receive participating notifications via email.|
25-
`participating.web`|`boolean` | `true` to receive participating notifications via web.|
26-
`watching.email`|`boolean` | `true` to receive watching notifications via email.|
27-
`watching.web`|`boolean` | `true` to receive watching notifications via web.|
22+
Name | Type | Description
23+
-----|------|--------------
24+
`participating.email`|`boolean` | `true` to receive participating notifications via email.
25+
`participating.web`|`boolean` | `true` to receive participating notifications via web.
26+
`watching.email`|`boolean` | `true` to receive watching notifications via email.
27+
`watching.web`|`boolean` | `true` to receive watching notifications via web.
2828

2929
#### Example
3030

@@ -54,9 +54,9 @@ Name | Type | Description | Default
5454

5555
### Parameters
5656

57-
Name | Type | Description | Default
58-
----|------|--------------|---------
59-
`email`|`string` | **Required**. Email address to where notifications to the authenticated user fare sent or discussions related to projects for this organization.|
57+
Name | Type | Description
58+
-----|------|--------------
59+
`email`|`string` | **Required**. Email address to where notifications to the authenticated user fare sent or discussions related to projects for this organization.
6060

6161

6262
## Update Organization email settings
@@ -67,8 +67,8 @@ Update the notification settings for the authenticated user.
6767

6868
### Parameters
6969

70-
Name | Type | Description | Default
71-
----|------|--------------|---------
72-
`email`|`string` | **Required**. Email address to where notifications to the authenticated user are sent for discussions related to projects for this organization.|
70+
Name | Type | Description
71+
-----|------|--------------
72+
`email`|`string` | **Required**. Email address to where notifications to the authenticated user are sent for discussions related to projects for this organization.
7373

7474

‎content/v3/activity/starring.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ List repositories being starred by the authenticated user.
5151

5252
### Parameters
5353

54-
Name | Type | Description | Default
55-
----|------|--------------|---------
56-
`sort`|`string` | One of `created` (when the repository was starred) or `updated` (when it was last pushed to).|`created`
57-
`direction`|`string` | One of `asc` or `desc`.|`desc`
54+
Name | Type | Description
55+
-----|------|--------------
56+
`sort`|`string` | One of `created` (when the repository was starred) or `updated` (when it was last pushed to). Default: `created`
57+
`direction`|`string` | One of `asc` (ascending) or `desc` (descending). Default: `desc`
5858

5959

6060
### Response

‎content/v3/activity/watching.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,10 @@ List repositories being watched by the authenticated user.
6262

6363
### Parameters
6464

65-
Name | Type | Description | Default
66-
----|------|--------------|---------
67-
`subscribed`|`boolean`| Determines if notifications should be received from this repository.|
68-
`ignored`|`boolean`| Determines if all notifications should be blocked from this repository.|
65+
Name | Type | Description
66+
-----|------|--------------
67+
`subscribed`|`boolean`| Determines if notifications should be received from this repository.
68+
`ignored`|`boolean`| Determines if all notifications should be blocked from this repository.
6969

7070

7171
### Response

‎content/v3/gists.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ List the authenticated user's starred gists:
3636

3737
### Parameters
3838

39-
Name | Type | Description | Default
40-
----|------|--------------|---------
41-
`since`|`string` | A timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.|
39+
Name | Type | Description
40+
-----|------|--------------
41+
`since`|`string` | A timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.
4242

4343
### Response
4444

@@ -62,11 +62,11 @@ _Note_: When using the [v3 media type][2] the "user" field will become "owner"
6262

6363
### Input
6464

65-
Name | Type | Description | Default
66-
----|------|--------------|---------
67-
`files`|`hash` | **Required**. Files that make up this gist.|
68-
`description`|`string` | A description of the gist.|
69-
`public`|`boolean` | Indicates whether the gist is public. |`false`
65+
Name | Type | Description
66+
-----|------|--------------
67+
`files`|`hash` | **Required**. Files that make up this gist.
68+
`description`|`string` | A description of the gist.
69+
`public`|`boolean` | Indicates whether the gist is public. Default: `false`
7070

7171
The keys in the `files` hash are the `string` filename, and the value is another `hash` with a key of `content`, and a value of the file contents. For example:
7272

@@ -92,12 +92,12 @@ format of the automatic naming scheme that Gist uses internally.
9292

9393
### Input
9494

95-
Name | Type | Description | Default
96-
----|------|--------------|---------
97-
`description`|`string` | A description of the gist.|
98-
`files`|`hash` | Files that make up this gist.|
99-
`content`|`string` | Updated file contents.|
100-
`filename`|`string` | New name for this file.|
95+
Name | Type | Description
96+
-----|------|--------------
97+
`description`|`string` | A description of the gist.
98+
`files`|`hash` | Files that make up this gist.
99+
`content`|`string` | Updated file contents.
100+
`filename`|`string` | New name for this file.
101101

102102
The keys in the `files` hash are the `string` filename. The value is another `hash` with a key of `content` (indicating the new contents), or `filename` (indicating the new filename). For example:
103103

‎content/v3/gists/comments.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ You can read more about the use of media types in the API
3535

3636
### Parameters
3737

38-
Name | Type | Description | Default
39-
----|------|--------------|---------
40-
`body`|`string` | **Required**. The comment text.|
38+
Name | Type | Description
39+
-----|------|--------------
40+
`body`|`string` | **Required**. The comment text.
4141

4242

4343
<%= json :body => 'Just commenting for the sake of commenting' %>
@@ -54,9 +54,9 @@ Name | Type | Description | Default
5454

5555
### Input
5656

57-
Name | Type | Description | Default
58-
----|------|--------------|---------
59-
`body`|`string` | **Required**. The comment text.|
57+
Name | Type | Description
58+
-----|------|--------------
59+
`body`|`string` | **Required**. The comment text.
6060

6161

6262
<%= json :body => 'Just commenting for the sake of commenting' %>

‎content/v3/git/commits.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ title: Git Commits | GitHub API
2222

2323
### Parameters
2424

25-
Name | Type | Description | Default
26-
----|------|--------------|---------
27-
`message`|`string` | **Required**. The commit message|
28-
`tree`|`string` | **Required**. The SHA of the tree object this commit points to|
29-
`parents`|`array` of `string`s| **Required**. The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.|
25+
Name | Type | Description
26+
-----|------|--------------
27+
`message`|`string` | **Required**. The commit message
28+
`tree`|`string` | **Required**. The SHA of the tree object this commit points to
29+
`parents`|`array` of `string`s| **Required**. The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.
3030

3131

3232
### Optional Parameters
@@ -41,11 +41,11 @@ in with the authenticated user's information and the current date.
4141

4242
Both the `author` and `commiter` parameters have the same keys:
4343

44-
Name | Type | Description | Default
45-
-----|------|-------------|---------
46-
`name`|`string` | The name of the author (or commiter) of the commit|
47-
`email`|`string` | The email of the author (or commiter) of the commit|
48-
`date`|`string` | Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
44+
Name | Type | Description
45+
-----|------|-------------
46+
`name`|`string` | The name of the author (or commiter) of the commit
47+
`email`|`string` | The email of the author (or commiter) of the commit
48+
`date`|`string` | Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
4949

5050
### Example Input
5151

‎content/v3/git/refs.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ For a full refs listing, you'll get something that looks like:
4646

4747
### Parameters
4848

49-
Name | Type | Description | Default
50-
----|------|--------------|---------
51-
`ref`|`type`| The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.|
52-
`sha`|`type`| The SHA1 value to set this reference to|
49+
Name | Type | Description
50+
-----|------|--------------
51+
`ref`|`type`| The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.
52+
`sha`|`type`| The SHA1 value to set this reference to
5353

5454

5555
### Input
@@ -68,10 +68,10 @@ Name | Type | Description | Default
6868

6969
### Parameters
7070

71-
Name | Type | Description | Default
72-
----|------|--------------|---------
73-
`sha`|`type`| The SHA1 value to set this reference to|
74-
`force`|`boolean`| Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.|`false`
71+
Name | Type | Description
72+
-----|------|--------------
73+
`sha`|`type`| The SHA1 value to set this reference to
74+
`force`|`boolean`| Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. Default: `false`
7575

7676

7777
### Input

‎content/v3/git/tags.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,21 @@ would be unnecessary.
3333

3434
### Parameters
3535

36-
Name | Type | Description | Default
37-
----|------|--------------|---------
38-
`tag`|`string`| The tag|
39-
`message`|`string`| The tag message|
40-
`object`|`string`| The SHA of the git object this is tagging|
41-
`type`|`string`| The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.|
42-
`tagger`|`hash`| A hash with information about the individual creating the tag.|
36+
Name | Type | Description
37+
-----|------|--------------
38+
`tag`|`string`| The tag
39+
`message`|`string`| The tag message
40+
`object`|`string`| The SHA of the git object this is tagging
41+
`type`|`string`| The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.
42+
`tagger`|`hash`| A hash with information about the individual creating the tag.
4343

4444
The `tagger` hash contains the following keys:
4545

46-
Name | Type | Description | Default
47-
----|------|--------------|---------
48-
`name`|`string`| The name of the author of the tag|
49-
`email`|`string`| The email of the author of the tag|
50-
`date`|`string`| When this object was tagged. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
46+
Name | Type | Description
47+
-----|------|--------------
48+
`name`|`string`| The name of the author of the tag
49+
`email`|`string`| The email of the author of the tag
50+
`date`|`string`| When this object was tagged. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
5151

5252

5353
### Example Input

‎content/v3/git/trees.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,20 +36,20 @@ a new tree out.
3636

3737
### Parameters
3838

39-
Name | Type | Description | Default
40-
----|------|--------------|---------
41-
`tree`|`array` of `hash`es | **Required**. Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure|
42-
`base_tree`| `string` | The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.|
39+
Name | Type | Description
40+
-----|------|--------------
41+
`tree`|`array` of `hash`es | **Required**. Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure
42+
`base_tree`| `string` | The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.
4343

4444
The `tree` parameter takes the following keys:
4545

46-
Name | Type | Description | Default
47-
----|------|--------------|---------
48-
`path`|`string`| The file referenced in the tree|
49-
`mode`|`string`| The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink|
50-
`type`| `string`| Either `blob`, `tree`, or `commit`|
51-
`sha`|`string`| The SHA1 checksum ID of the object in the tree|
52-
`content`|`string` | The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`.|
46+
Name | Type | Description
47+
-----|------|--------------
48+
`path`|`string`| The file referenced in the tree
49+
`mode`|`string`| The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink
50+
`type`| `string`| Either `blob`, `tree`, or `commit`
51+
`sha`|`string`| The SHA1 checksum ID of the object in the tree
52+
`content`|`string` | The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`.
5353

5454

5555
### Input

0 commit comments

Comments
 (0)