Skip to content
This repository has been archived by the owner on Apr 26, 2021. It is now read-only.

Commit

Permalink
docs/source/api: adjust docs regarding how emails are returned
Browse files Browse the repository at this point in the history
The API returns emails surrounded by `<` and `>` – e.g.:

```json
...
"committer" : {
    "email" : "<gandalf@example.com>",
    "...": "..."
},
...
```
  • Loading branch information
scorphus committed Jun 30, 2015
1 parent 08288c0 commit 0ba5cad
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -210,12 +210,12 @@ Example result::
createdAt: "Mon Jul 28 10:13:27 2014 -0300"
author: {
name: "Author name",
email: "author@email.com",
email: "<author@email.com>",
date: "Mon Jul 28 10:13:27 2014 -0300""
},
committer: {
name: "Committer name",
email: "committer@email.com",
email: "<committer@email.com>",
date: "Tue Jul 29 13:43:57 2014 -0300"
},
_links: {
Expand Down Expand Up @@ -250,12 +250,12 @@ Example result::
createdAt: "Mon Jul 28 10:13:27 2014 -0300"
author: {
name: "Author name",
email: "author@email.com",
email: "<author@email.com>",
date: "Mon Jul 28 10:13:27 2014 -0300""
},
committer: {
name: "Committer name",
email: "committer@email.com",
email: "<committer@email.com>",
date: "Tue Jul 29 13:43:57 2014 -0300"
},
_links: {
Expand Down Expand Up @@ -360,12 +360,12 @@ Example result::
createdAt: "Mon Jul 28 10:13:27 2014 -0300"
author: {
name: "Author Name",
email: "author@email.com",
email: "<author@email.com>",
date: "Mon Jul 28 10:13:27 2014 -0300""
},
committer: {
name: "Committer Name",
email: "committer@email.com",
email: "<committer@email.com>",
date: "Tue Jul 29 13:43:57 2014 -0300"
},
_links: {
Expand Down Expand Up @@ -402,12 +402,12 @@ Example result::
createdAt: "Mon Jul 28 10:13:27 2014 -0300"
author: {
name: "Author name",
email: "author@email.com",
email: "<author@email.com>",
date: "Mon Jul 28 10:13:27 2014 -0300""
},
committer: {
name: "Committer name",
email: "committer@email.com",
email: "<committer@email.com>",
date: "Tue Jul 29 13:43:57 2014 -0300"
},
parent: [
Expand Down

0 comments on commit 0ba5cad

Please sign in to comment.