openstack
/
cinder
Code Issues Proposed changes

[DOC BLD FIX] Fix formatting in cinder.compute.nova 

The docstring for novaclient was not properly
formatted causing Sphinx to generate warnings and the
resulting document was not bolded properly.

This change corrects the formatting to remove the
warning and enable proper doc generation.

Change-Id: Ibe204e8ed2cc2d0557cb9ad4a0f2bf3a61744387
This commit is contained in:
Jay S. Bryant 2017-07-17 16:04:43 -05:00
parent 817f34ce5d
commit b5fe8f6eb1
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
cinder/compute/nova.py
View File

@ -107,12 +107,15 @@ def _get_identity_endpoint_from_sc(context):
def novaclient(context, privileged_user=False, timeout=None, api_version=None):
"""Returns a Nova client
@param privileged_user: If True, use the account from configuration
@param privileged_user:
If True, use the account from configuration
(requires 'auth_type' and the other usual Keystone authentication
options to be set in the [nova] section)
@param timeout: Number of seconds to wait for an answer before raising a
@param timeout:
Number of seconds to wait for an answer before raising a
Timeout exception (None to disable)
@param api_version: api version of nova
@param api_version:
api version of nova
"""
if privileged_user and CONF[NOVA_GROUP].auth_type: