Merge pull request #43691 from dmyerscough/fix-docstring-formatting

Fix docstring code-blocks
saltstack · Sep 22, 2017 · 7448153 · 7448153
2 parents d7b19ab + 012281d
commit 7448153
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 15 deletions.
diff --git a/salt/cloud/clouds/digitalocean.py b/salt/cloud/clouds/digitalocean.py
@@ -969,7 +969,7 @@ def list_floating_ips(call=None):
 
     CLI Examples:
 
-    ... code-block:: bash
+    .. code-block:: bash
 
         salt-cloud -f list_floating_ips my-digitalocean-config
     '''
@@ -1009,7 +1009,7 @@ def show_floating_ip(kwargs=None, call=None):
 
     CLI Examples:
 
-    ... code-block:: bash
+    .. code-block:: bash
 
         salt-cloud -f show_floating_ip my-digitalocean-config floating_ip='45.55.96.47'
     '''
@@ -1042,7 +1042,7 @@ def create_floating_ip(kwargs=None, call=None):
 
     CLI Examples:
 
-    ... code-block:: bash
+    .. code-block:: bash
 
         salt-cloud -f create_floating_ip my-digitalocean-config region='NYC2'
 
@@ -1084,7 +1084,7 @@ def delete_floating_ip(kwargs=None, call=None):
 
     CLI Examples:
 
-    ... code-block:: bash
+    .. code-block:: bash
 
         salt-cloud -f delete_floating_ip my-digitalocean-config floating_ip='45.55.96.47'
     '''
@@ -1119,7 +1119,7 @@ def assign_floating_ip(kwargs=None, call=None):
 
     CLI Examples:
 
-    ... code-block:: bash
+    .. code-block:: bash
 
         salt-cloud -f assign_floating_ip my-digitalocean-config droplet_id=1234567 floating_ip='45.55.96.47'
     '''
@@ -1152,7 +1152,7 @@ def unassign_floating_ip(kwargs=None, call=None):
 
     CLI Examples:
 
-    ... code-block:: bash
+    .. code-block:: bash
 
         salt-cloud -f unassign_floating_ip my-digitalocean-config floating_ip='45.55.96.47'
     '''

diff --git a/salt/modules/win_path.py b/salt/modules/win_path.py
@@ -51,7 +51,7 @@ def rehash():
 
     CLI Example:
 
-    ... code-block:: bash
+    .. code-block:: bash
 
         salt '*' win_path.rehash
     '''

diff --git a/salt/modules/zk_concurrency.py b/salt/modules/zk_concurrency.py
@@ -185,7 +185,7 @@ def lock_holders(path,
 
     Example:
 
-    ... code-block: bash
+    .. code-block: bash
 
         salt minion zk_concurrency.lock_holders /lock/path host1:1234,host2:1234
     '''
@@ -237,7 +237,7 @@ def lock(path,
 
     Example:
 
-    ... code-block: bash
+    .. code-block: bash
 
         salt minion zk_concurrency.lock /lock/path host1:1234,host2:1234
     '''
@@ -298,7 +298,7 @@ def unlock(path,
 
     Example:
 
-    ... code-block: bash
+    .. code-block: bash
 
         salt minion zk_concurrency.unlock /lock/path host1:1234,host2:1234
     '''
@@ -348,7 +348,7 @@ def party_members(path,
 
     Example:
 
-    ... code-block: bash
+    .. code-block: bash
 
         salt minion zk_concurrency.party_members /lock/path host1:1234,host2:1234
         salt minion zk_concurrency.party_members /lock/path host1:1234,host2:1234 min_nodes=3 blocking=True

diff --git a/salt/utils/boto.py b/salt/utils/boto.py
@@ -160,7 +160,7 @@ def cache_id_func(service):
     '''
     Returns a partial `cache_id` function for the provided service.
 
-    ... code-block:: python
+    .. code-block:: python
 
         cache_id = __utils__['boto.cache_id_func']('ec2')
         cache_id('myinstance', 'i-a1b2c3')
@@ -209,7 +209,7 @@ def get_connection_func(service, module=None):
     '''
     Returns a partial `get_connection` function for the provided service.
 
-    ... code-block:: python
+    .. code-block:: python
 
         get_conn = __utils__['boto.get_connection_func']('ec2')
         conn = get_conn()

diff --git a/salt/utils/boto3.py b/salt/utils/boto3.py
@@ -182,7 +182,7 @@ def cache_id_func(service):
     '''
     Returns a partial `cache_id` function for the provided service.
 
-    ... code-block:: python
+    .. code-block:: python
 
         cache_id = __utils__['boto.cache_id_func']('ec2')
         cache_id('myinstance', 'i-a1b2c3')
@@ -233,7 +233,7 @@ def get_connection_func(service, module=None):
     '''
     Returns a partial `get_connection` function for the provided service.
 
-    ... code-block:: python
+    .. code-block:: python
 
         get_conn = __utils__['boto.get_connection_func']('ec2')
         conn = get_conn()