fixing a few documentation warnings

allmightyspiff · allmightyspiff · commit e3a13379ff48 · 2020-09-30T17:14:30.000-05:00
diff --git a/SoftLayer/CLI/block/refresh.py b/SoftLayer/CLI/block/refresh.py
@@ -11,7 +11,10 @@
 @click.argument('snapshot_id')
 @environment.pass_env
 def cli(env, volume_id, snapshot_id):
-    """Refresh a duplicate volume with a snapshot from its parent."""
+    """Refresh a duplicate volume with a snapshot from its parent.
+
+
+    """
     block_manager = SoftLayer.BlockStorageManager(env.client)
     resp = block_manager.refresh_dupe(volume_id, snapshot_id)
 
diff --git a/SoftLayer/CLI/ticket/create.py b/SoftLayer/CLI/ticket/create.py
@@ -25,19 +25,18 @@
 def cli(env, title, subject_id, body, hardware_identifier, virtual_identifier, priority):
     """Create a Infrastructure support ticket.
 
-    Example::
-
-    Will create the ticket with `Some text`.
+    Will create the ticket with `Some text`.::
 
         slcli ticket create --body="Some text" --subject-id 1522 --hardware 12345 --title "My New Ticket"
 
-    Will create the ticket with text from STDIN
+    Will create the ticket with text from STDIN::
 
         cat sometfile.txt | slcli ticket create --subject-id 1003 --virtual 111111 --title "Reboot Me"
 
-    Will open the default text editor, and once closed, use that text to create the ticket
+    Will open the default text editor, and once closed, use that text to create the ticket::
 
         slcli ticket create --subject-id 1482 --title "Vyatta Questions..."
+
     """
     ticket_mgr = SoftLayer.TicketManager(env.client)
     if body is None:
diff --git a/SoftLayer/CLI/ticket/update.py b/SoftLayer/CLI/ticket/update.py
@@ -16,17 +16,15 @@
 def cli(env, identifier, body):
     """Adds an update to an existing ticket.
 
-    Example::
-
-    Will update the ticket with `Some text`.
+Will update the ticket with `Some text`.::
 
         slcli ticket update 123456 --body="Some text"
 
-    Will update the ticket with text from STDIN
+Will update the ticket with text from STDIN::
 
         cat sometfile.txt | slcli ticket update 123456
 
-    Will open the default text editor, and once closed, use that text to update the ticket
+Will open the default text editor, and once closed, use that text to update the ticket::
 
         slcli ticket update 123456
     """
diff --git a/docs/cli/block.rst b/docs/cli/block.rst
@@ -112,11 +112,11 @@ Block Commands
     :show-nested:
 
 .. click:: SoftLayer.CLI.block.refresh:cli
-   :prog block volume-refresh
+   :prog: block volume-refresh
    :show-nested:
 
 .. click:: SoftLayer.CLI.block.convert:cli
-   :prog block volume-convert
+   :prog: block volume-convert
    :show-nested:
 
 .. click:: SoftLayer.CLI.block.subnets.list:cli
diff --git a/docs/cli/file.rst b/docs/cli/file.rst
@@ -100,11 +100,11 @@ File Commands
     :show-nested:
 
 .. click:: SoftLayer.CLI.file.refresh:cli
-    :prog file volume-refresh
+    :prog: file volume-refresh
     :show-nested:
 
 .. click:: SoftLayer.CLI.file.convert:cli
-    :prog file volume-convert
+    :prog: file volume-convert
     :show-nested:
 
 .. click:: SoftLayer.CLI.file.snapshot.schedule_list:cli
diff --git a/docs/cli/tickets.rst b/docs/cli/tickets.rst
@@ -1,13 +1,14 @@
 .. _cli_tickets:
 
 Support Tickets
-===============
+=================
 
-The SoftLayer ticket API is used to create "classic" or Infrastructure Support cases.
-These tickets will still show up in your web portal, but for the more unified case management API,
-see the `Case Management API <https://cloud.ibm.com/apidocs/case-management#introduction>`_
+The SoftLayer ticket API is used to create "classic" or Infrastructure Support cases. These tickets will still show up in your web portal, but for the more unified case management API, see the `Case Management API <https://cloud.ibm.com/apidocs/case-management#introduction>`_
+
+.. note::
+
+    Windows Git-Bash users might run into issues with `ticket create` and `ticket update` if --body isn't used, as it doesn't report that it is a real TTY to python, so the default editor can not be launched.
 
-.. note:: Windows Git-Bash users might run into issues with `ticket create` and `ticket update` if --body isn't used, as it doesn't report that it is a real TTY to python, so the default editor can not be launched.
 
 .. click:: SoftLayer.CLI.ticket.create:cli
     :prog: ticket create
