aboutsummaryrefslogtreecommitdiffstats
path: root/docs/en
diff options
context:
space:
mode:
authorFrédéric Buclin <LpSolit@gmail.com>2015-12-21 16:54:40 +0100
committerFrédéric Buclin <LpSolit@gmail.com>2015-12-21 16:54:40 +0100
commit21366b449445bb33267f9839f9c843730446898a (patch)
treeae6f9d71dda84aef287f68f10a31e9740ff082fb /docs/en
parente4b915b77106eb5bd7b677abeb06f69a68267564 (diff)
downloadbugs-21366b449445bb33267f9839f9c843730446898a.tar
bugs-21366b449445bb33267f9839f9c843730446898a.tar.gz
bugs-21366b449445bb33267f9839f9c843730446898a.tar.bz2
bugs-21366b449445bb33267f9839f9c843730446898a.tar.xz
bugs-21366b449445bb33267f9839f9c843730446898a.zip
Bug 1234056: The "Create Comments" documentation incorrectly mentions that you can add a comment to several bugs at once
r/a=dkl
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/rst/api/core/v1/comment.rst5
1 files changed, 0 insertions, 5 deletions
diff --git a/docs/en/rst/api/core/v1/comment.rst b/docs/en/rst/api/core/v1/comment.rst
index 60fabb93b..946cf79fe 100644
--- a/docs/en/rst/api/core/v1/comment.rst
+++ b/docs/en/rst/api/core/v1/comment.rst
@@ -122,19 +122,14 @@ To create a comment on a current bug.
.. code-block:: js
{
- "ids" : [123,..],
"comment" : "This is an additional comment",
"is_private" : false
}
-``ids`` is optional in the data example above and can be used to specify adding
-a comment to more than one bug at the same time.
-
=========== ======= ===========================================================
name type description
=========== ======= ===========================================================
**id** int The ID or alias of the bug to append a comment to.
-ids array List of integer bug IDs to add the comment to.
**comment** string The comment to append to the bug. If this is empty
or all whitespace, an error will be thrown saying that you
did not set the ``comment`` parameter.