Skip to content

Commit

Permalink
UPDATE Usage.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
K-Gazdikova committed Jun 16, 2017
1 parent d36f4ef commit 88a44f9
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions read-the-docs/source/Usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Usage
**The general usage workflow for creating new tickets is:**

.. highlight::

Create a JiraTicket, RTTicket, RedmineTicket, BugzillaTicket
or ServiceNowTicket object with ``<url>``, ``<project>`` and ``<auth>``. This
verifies that you are able to properly authenticate to the ticketing tool.
Expand All @@ -13,26 +14,27 @@ Usage
'kerberos'.

.. hlist::
- Create a ticket with the ``create()`` method. This sets the ``ticket_id``
instance variable, allowing you to perform more tasks on the ticket.

- Add comments, edit ticket fields, add watchers, change the ticket
status, etc on the ticket.
- Create a ticket with the ``create()`` method. This sets the ``ticket_id``
instance variable, allowing you to perform more tasks on the ticket.

- Add comments, edit ticket fields, add watchers, change the ticket
status, etc on the ticket.

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

- To work on existing tickets, you can also pass in a fourth parameter
when creating a Ticket object: ``<ticket_id>``. The general workflow for
working with existing tickets is as follows:
- To work on existing tickets, you can also pass in a fourth parameter
when creating a Ticket object: ``<ticket_id>``. The general workflow for
working with existing tickets is as follows:

- Create a JiraTicket, RTTicket, RedmineTicket, BugzillaTicket
or ServiceNowTicket object with ``<url>``, ``<project_key>``, ``<auth>`` and
``<ticket_id>``.
- Create a JiraTicket, RTTicket, RedmineTicket, BugzillaTicket
or ServiceNowTicket object with ``<url>``, ``<project_key>``, ``<auth>`` and
``<ticket_id>``.

- Add comments, edit ticket fields, add watchers, change the ticket
status, etc on the ticket.
- Add comments, edit ticket fields, add watchers, change the ticket
status, etc on the ticket.

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

* 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 Down

0 comments on commit 88a44f9

Please sign in to comment.