Skip to content

Commit 6244d62

Browse files
gjtorikiangjtorikian
committed
Add an #### Example header to input examples
For great justice, and also, easier linking
1 parent b51eaa0 commit 6244d62

9 files changed

Lines changed: 17 additions & 0 deletions

File tree

‎content/v3/activity/settings.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Name | Type | Description | Default
2626
`watching.email`|`boolean` | `true` to receive watching notifications via email.|
2727
`watching.web`|`boolean` | `true` to receive watching notifications via web.|
2828

29+
#### Example
2930

3031
<%= json \
3132
:participating => {:email => true, :web => false},

‎content/v3/issues/milestones.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Name | Type | Description | Default
4747
`description`|`string` | A description of the milestone.|
4848
`due_on`|`time` | The milestone due date. The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`|
4949

50+
#### Example
5051

5152
<%= json \
5253
:title => "String",
@@ -75,6 +76,7 @@ Name | Type | Description | Default
7576
`description`|`string` | A description of the milestone.|
7677
`due_on`|`time` | The milestone due date. The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`|
7778

79+
#### Example
7880

7981
<%= json \
8082
:title => "String",

‎content/v3/orgs.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Name | Type | Description | Default
4545
`location`|`string` | The location.|
4646
`name`|`string` | The shorthand name of the company.|
4747

48+
### Example
4849

4950
<%= json \
5051
:billing_email => "support@github.com",

‎content/v3/orgs/teams.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Name | Type | Description | Default
4444
`repo_names`|`array` of `strings` | The repositories to add the team to.|
4545
`permission`|`string` | The permission to grant the team. Can be one of:<br/> * `pull` - team members can pull, but not push to or administer these repositories.<br/> * `push` - team members can pull and push, but not administer these repositories.<br/> * `admin` - team members can pull, push and administer these repositories.| `pull`
4646

47+
#### Example
4748

4849
<%= json \
4950
:name => 'new team',
@@ -69,6 +70,7 @@ Name | Type | Description | Default
6970
`name`|`string` | **Required**. The name of the team.|
7071
`permission`|`string` | The permission to grant the team. Can be one of:<br/> * `pull` - team members can pull, but not push to or administer these repositories.<br/> * `push` - team members can pull and push, but not administer these repositories.<br/> * `admin` - team members can pull, push and administer these repositories.| `pull`
7172

73+
#### Example
7274

7375
<%= json \
7476
:name => 'new team name',

‎content/v3/pulls.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ Name | Type | Description | Default
8585
NOTE: `head` and `base` can be either a sha or a branch name. Typically you
8686
would namespace `head` with a user like this: `username:branch`.
8787

88+
#### Example
89+
8890
<%= json \
8991
:title => "Amazing new feature",
9092
:body => "Please pull this in!",
@@ -101,6 +103,7 @@ Name | Type | Description | Default
101103
-----|------|-------------|---------
102104
`issue`|`number` | **Required**. The issue number in this repository to turn into a Pull Request.|
103105

106+
#### Example
104107

105108
<%= json \
106109
:issue => "5",
@@ -125,6 +128,7 @@ Name | Type | Description | Default
125128
`body`|`string` | The contents of the pull request.|
126129
`state`|`string` | State of this Pull Request. Either `open` or `closed`.|
127130

131+
#### Example
128132

129133
<%= json \
130134
:title => "new title",

‎content/v3/repos.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ Name | Type | Description | Default
108108
`auto_init`|`boolean` | Pass `true` to create an initial commit with empty README.|`false`
109109
`gitignore_template`|`string` | Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". _Ignored if the `auto_init` parameter is not provided._|
110110

111+
#### Example
111112

112113
<%= json \
113114
:name => "Hello-World",
@@ -156,6 +157,7 @@ Name | Type | Description | Default
156157
`has_downloads`|`boolean` | Either `true` to enable downloads for this repository, `false` to disable them.|`true`
157158
`default_branch`|`String` | Updates the default branch for this repository.|
158159

160+
#### Example
159161

160162
<%= json \
161163
:name => "Hello-World",

‎content/v3/repos/releases.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ Name | Type | Description | Default
4949
`draft`|`boolean` | `true` to create a draft (unpublished) release, `false` to create a published one.|`false`
5050
`prerelease`|`boolean` | `true` to identify the release as a prerelease. `false` to identify the release as a full release.|`false`
5151

52+
#### Example
5253

5354
<%= json \
5455
:tag_name => "v1.0.0",
@@ -82,6 +83,7 @@ Name | Type | Description | Default
8283
`draft`|`boolean` | `true` makes the release a draft, and `false` publishes the release.|
8384
`prerelease`|`boolean` | `true` to identify the release as a prerelease, `false` to identify the release as a full release.|
8485

86+
#### Example
8587

8688
<%= json \
8789
:tag_name => "v1.0.0",
@@ -187,6 +189,7 @@ Name | Type | Description | Default
187189
`name`|`string` | **Required**. The file name of the asset.|
188190
`label`|`string` | An alternate short description of the asset. Used in place of the filename.|
189191

192+
#### Example
190193

191194
<%= json \
192195
:name => "foo-1.0.0-osx.zip",

‎content/v3/repos/statuses.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Name | Type | Description | Default
5757
`target_url`|`string` | The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the 'source' of the Status.<br/>For example, if your Continuous Integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:<br/>`http://ci.example.com/user/repo/build/sha`.|
5858
`description`|`string` | A short description of the status|
5959

60+
#### Example
6061

6162
<%= json \
6263
:state => "success",

‎content/v3/users.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ Name | Type | Description | Default
5050
`hireable`|`boolean` | The new hiring availability of the user|
5151
`bio`|`string` | The new short biography of the user|
5252

53+
#### Example
5354

5455
<%= json \
5556
:name => "monalisa octocat",

0 commit comments

Comments
 (0)