Skip to content

Commit

Permalink
- UPDATE Usage.rst with modification for the content.
Browse files Browse the repository at this point in the history
- UPDATE .gitignore for excluding build/ directory.
  • Loading branch information
K-Gazdikova committed Jun 21, 2017
1 parent 99ff864 commit cd4d09d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ __pycache__/
*.idea
*.pyc
dist
*.egg-info/
*.egg-info/
build/
15 changes: 10 additions & 5 deletions read-the-docs/source/Usage.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Usage
=====

.. rst:role:: The general usage for creating new tickets
Create a Ticket object
----------------------

Create a JiraTicket, RTTicket, RedmineTicket, BugzillaTicket
or ServiceNowTicket object with ``<url>``, ``<project>`` and ``<auth>``. This
Expand All @@ -12,7 +13,8 @@ authentication (JIRA and RT), the ``<auth>`` parameter should contain
'kerberos'.


.. rst:role:: Workflow for ticketutil
Work with a new ticket
----------------------

- Create a ticket with the ``create()`` method. This sets the ``ticket_id``
instance variable, allowing you to perform more tasks on the ticket.
Expand All @@ -35,7 +37,8 @@ authentication (JIRA and RT), the ``<auth>`` parameter should contain

- Close ticket Requests session with ``close_requests_session()``.

.. rst:role:: Check set_ticket_id() for working with a Ticket object
Work with an existing ticket
----------------------------

There is also a ``set_ticket_id()`` method for a Ticket object. This is
useful if you are working with a Ticket object that already has the
Expand All @@ -44,10 +47,12 @@ on a separate ticket. Instead of creating a new Ticket object, you can
simply pass an existing ``<ticket_id>`` in to the ``set_ticket_id()``
method to begin working on another ticket.

.. rst:role:: Workflow for the same
- To return the current Ticket object's ticket_id or ticket_url, use the ``get_ticket_id()`` or ``get_ticket_url()`` methods.


Running unit tests
------------------

- To run unit tests in Bash terminal use this command:

.. code-block:: python
Expand Down

0 comments on commit cd4d09d

Please sign in to comment.