Skip to content

Commit

Permalink
ADD unit tests for jira.py
Browse files Browse the repository at this point in the history
- Add unit tests for jira.py
- Add 'type' as a required parameter for jira's create() method.
- Update documentation with 'type' as a required parameter.
  • Loading branch information
mjagelka authored and dmranck committed Jul 5, 2018
1 parent 4740f78 commit 07ae6c3
Show file tree
Hide file tree
Showing 4 changed files with 504 additions and 11 deletions.
3 changes: 2 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ Simplify all of your ticketing operations with ticketutil:
# Create a ticket and perform some common ticketing operations.
t = ticket.create(summary='Ticket summary',
description='Ticket description')
description='Ticket description',
type='Task')
t = ticket.add_comment('Test Comment')
t = ticket.change_status('Done')
Expand Down
7 changes: 4 additions & 3 deletions read-the-docs/source/JIRA.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,17 @@ Methods
create()
--------

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

Creates a ticket. The required parameters for ticket creation are
summary and description. Keyword arguments are used for other ticket
summary, description and type. Keyword arguments are used for other ticket
fields.

.. code:: python
t = ticket.create(summary='Ticket summary',
description='Ticket description')
description='Ticket description',
type='Task')
The following keyword arguments were tested and accepted by our
particular JIRA instance during ticket creation:
Expand Down

0 comments on commit 07ae6c3

Please sign in to comment.