From b5fe8f6eb115e84f93718d2bcce3318ba671d38a Mon Sep 17 00:00:00 2001 From: "Jay S. Bryant" Date: Mon, 17 Jul 2017 16:04:43 -0500 Subject: [PATCH] [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 --- cinder/compute/nova.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/cinder/compute/nova.py b/cinder/compute/nova.py index 8843a3582c7..43274df73b4 100644 --- a/cinder/compute/nova.py +++ b/cinder/compute/nova.py @@ -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: