Skip to content

Commit

Permalink
UPDATE JIRA.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
K-Gazdikova committed Jun 16, 2017
1 parent 5ef65e4 commit d8f4de3
Showing 1 changed file with 32 additions and 16 deletions.
48 changes: 32 additions & 16 deletions read-the-docs/source/JIRA.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,10 @@ Methods
- `add\_watcher() <#add_watcher>`__
- `add\_attachment() <#add_attachment>`__

create(self, summary, description, **kwargs)
--------------------------------------------
create()
--------

``create(self, summary, description, **kwargs)``

Creates a ticket. The required parameters for ticket creation are
summary and description. Keyword arguments are used for other ticket
Expand All @@ -53,8 +55,10 @@ particular JIRA instance during ticket creation:
parent='KEY-XX'
customfield_XXXXX='Custom field text'
edit(self, **kwargs)
--------------------
edit()
------

``edit(self, **kwargs)``

Edits fields in a JIRA ticket. Keyword arguments are used to specify
ticket fields.
Expand All @@ -79,53 +83,65 @@ particular JIRA instance during ticket editing:
parent='KEY-XX'
customfield_XXXXX='Custom field text'
add_comment(self, comment)
--------------------------
add_comment()
-------------

``add_comment(self, comment)``

Adds a comment to a JIRA ticket.

.. code:: python
t.add_comment('Test comment')
change_status(self, status)
---------------------------
change_status()
---------------

``change_status(self, status)``

Changes status of a JIRA ticket.

.. code:: python
t.change_status('In Progress')
remove_all_watchers(self)
-------------------------
remove_all_watchers()
---------------------

``remove_all_watchers(self)``

Removes all watchers from a JIRA ticket.

.. code:: python
t.remove_all_watchers()
remove_watcher(self, watcher)
-----------------------------
remove_watcher()
----------------

``remove_watcher(self, watcher)``

Removes watcher from a JIRA ticket. Accepts an email or username.

.. code:: python
t.remove_watcher('username')
add_watcher(self, watcher)
--------------------------
add_watcher()
-------------

``add_watcher(self, watcher)``

Adds watcher to a JIRA ticket. Accepts an email or username.

.. code:: python
t.add_watcher('username')
add_attachment(self, file_name)
-------------------------------
add_attachment()
----------------

``add_attachment(self, file_name)``

Attaches a file to a JIRA ticket.

Expand Down

0 comments on commit d8f4de3

Please sign in to comment.