FIX for '\' in Methods for all the tools file(.rst)

UPDATE Usage.rst and Installation.rst with the suggested changes from the PR FIX bullet section line "23" for ServiceNow.rst
dmranck · Jun 22, 2017 · 0e1b34f · 0e1b34f
1 parent 061e37e
commit 0e1b34f
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 37 deletions.
diff --git a/read-the-docs/source/Installation.rst b/read-the-docs/source/Installation.rst
@@ -1,7 +1,7 @@
 Installation
 ============
 
-* Install ticketutil with,
+* Install ticketutil with:
 
 .. code:: python
 
@@ -13,7 +13,7 @@ Installation
 
     For Python 2.6 and lower, an additional package, importlib, may need to be installed.
 
-* If not installing with pip, a short list of packages defined in the requirements.txt file need to be installed. To install the required packages with,
+* If not installing with pip, a short list of packages defined in the requirements.txt file need to be installed. To install the required packages, type:
 
 .. code:: python
 

diff --git a/read-the-docs/source/Redmine.rst b/read-the-docs/source/Redmine.rst
@@ -23,11 +23,11 @@ Methods
 
 -  `create() <#create>`__
 -  `edit() <#edit>`__
--  `add\_comment() <#comment>`__
--  `change\_status() <#status>`__
--  `remove\_watcher() <#remove_watcher>`__
--  `add\_watcher() <#add_watcher>`__
--  `add\_attachment() <#add_attachment>`__
+-  `add_comment() <#comment>`__
+-  `change_status() <#status>`__
+-  `remove_watcher() <#remove_watcher>`__
+-  `add_watcher() <#add_watcher>`__
+-  `add_attachment() <#add_attachment>`__
 
 
 create()

diff --git a/read-the-docs/source/ServiceNow.rst b/read-the-docs/source/ServiceNow.rst
@@ -19,26 +19,25 @@ API right afterwards. You can also use
 `get\_ticket\_content <#content>`__ to get ticket content including
 preset field names.
 
-For more information about REST API and fields see ServiceNow's Wiki: -
-`REST API <http://wiki.servicenow.com/index.php?title=REST_API>`__ -
-`Introduction to
-Fields <http://wiki.servicenow.com/index.php?title=Introduction_to_Fields>`__
--
-`Dot-Walking <http://wiki.servicenow.com/index.php?title=Dot-Walking>`__
+For more information about REST API and fields see ServiceNow's Wiki:
+
+- `REST API <http://wiki.servicenow.com/index.php?title=REST_API>`__
+- `Introduction to Fields <http://wiki.servicenow.com/index.php?title=Introduction_to_Fields>`__
+- `Dot-Walking <http://wiki.servicenow.com/index.php?title=Dot-Walking>`__
 
 
 Methods
 ^^^^^^^
 
--  `set\_ticket\_id() <#set_ticket>`__
+-  `set_ticket_id() <#set_ticket>`__
 -  `create() <#create>`__
--  `get\_ticket\_content() <#content>`__
+-  `get_ticket_content() <#content>`__
 -  `edit() <#edit>`__
--  `add\_comment() <#comment>`__
--  `change\_status() <#status>`__
--  `add\_cc() <#add_cc>`__
--  `rewrite\_cc() <#rewrite_cc>`__
--  `remove\_cc() <#remove_cc>`__
+-  `add_comment() <#comment>`__
+-  `change_status() <#status>`__
+-  `add_cc() <#add_cc>`__
+-  `rewrite_cc() <#rewrite_cc>`__
+-  `remove_cc() <#remove_cc>`__
 
 set_ticket_id()
 ---------------

diff --git a/read-the-docs/source/Usage.rst b/read-the-docs/source/Usage.rst
@@ -24,6 +24,17 @@ Work with a new ticket
 
 + Close ticket Requests session with ``close_requests_session()``.
 
+
+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
+``<ticket_id>`` instance variable set, but would like to begin working
+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.
+
 + 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:
@@ -37,18 +48,8 @@ Work with a new ticket
 
 + Close ticket Requests session with ``close_requests_session()``.
 
-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
-``<ticket_id>`` instance variable set, but would like to begin working
-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.
-
-To return the current Ticket object's ticket_id or ticket_url, use the
-``get_ticket_id()`` or ``get_ticket_url()`` methods.
++ 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
@@ -62,8 +63,8 @@ To run unit tests in Bash terminal use this command:
 
 .. seealso::
 
-    See the docstrings in the code or the tool-specific files in the docs
-    and examples directories for more information.
+    See the docstrings in the code or the tool-specific sections in the documentation for more information on
+    supported methods and examples.
 
 .. note::
     Note on logging: To enable debug logging for ticketutil, set an environment

diff --git a/read-the-docs/source/rt.rst b/read-the-docs/source/rt.rst
@@ -18,9 +18,9 @@ Methods
 
 -  `create() <#create>`__
 -  `edit() <#edit>`__
--  `add\_comment() <#comment>`__
--  `change\_status() <#status>`__
--  `add\_attachment() <#add_attachment>`__
+-  `add_comment() <#comment>`__
+-  `change_status() <#status>`__
+-  `add_attachment() <#add_attachment>`__
 
 
 create()