From 0ba5cad275e0e76e6410b51744903e8bd214ad4a Mon Sep 17 00:00:00 2001 From: Pablo Santiago Blum de Aguiar Date: Mon, 29 Jun 2015 23:09:16 -0300 Subject: [PATCH] docs/source/api: adjust docs regarding how emails are returned MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The API returns emails surrounded by `<` and `>` – e.g.: ```json ... "committer" : { "email" : "", "...": "..." }, ... ``` --- docs/source/api.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/source/api.rst b/docs/source/api.rst index 0a4e9ea..18e1491 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -210,12 +210,12 @@ Example result:: createdAt: "Mon Jul 28 10:13:27 2014 -0300" author: { name: "Author name", - email: "author@email.com", + email: "", date: "Mon Jul 28 10:13:27 2014 -0300"" }, committer: { name: "Committer name", - email: "committer@email.com", + email: "", date: "Tue Jul 29 13:43:57 2014 -0300" }, _links: { @@ -250,12 +250,12 @@ Example result:: createdAt: "Mon Jul 28 10:13:27 2014 -0300" author: { name: "Author name", - email: "author@email.com", + email: "", date: "Mon Jul 28 10:13:27 2014 -0300"" }, committer: { name: "Committer name", - email: "committer@email.com", + email: "", date: "Tue Jul 29 13:43:57 2014 -0300" }, _links: { @@ -360,12 +360,12 @@ Example result:: createdAt: "Mon Jul 28 10:13:27 2014 -0300" author: { name: "Author Name", - email: "author@email.com", + email: "", date: "Mon Jul 28 10:13:27 2014 -0300"" }, committer: { name: "Committer Name", - email: "committer@email.com", + email: "", date: "Tue Jul 29 13:43:57 2014 -0300" }, _links: { @@ -402,12 +402,12 @@ Example result:: createdAt: "Mon Jul 28 10:13:27 2014 -0300" author: { name: "Author name", - email: "author@email.com", + email: "", date: "Mon Jul 28 10:13:27 2014 -0300"" }, committer: { name: "Committer name", - email: "committer@email.com", + email: "", date: "Tue Jul 29 13:43:57 2014 -0300" }, parent: [