From 3fdc783850c15554869be6815483f0211b3825fe Mon Sep 17 00:00:00 2001 From: "Brian C. Lane" Date: Wed, 16 Oct 2019 13:52:54 -0700 Subject: [PATCH] docs: Fix Sphinx errors in docstrings --- src/lifted/providers.py | 3 +-- src/lifted/queue.py | 12 ++++-------- src/pylorax/api/v1.py | 2 +- 3 files changed, 6 insertions(+), 11 deletions(-) diff --git a/src/lifted/providers.py b/src/lifted/providers.py index dc97cb11..3397e762 100644 --- a/src/lifted/providers.py +++ b/src/lifted/providers.py @@ -147,8 +147,7 @@ def validate_settings(ucfg, provider_name, settings, image_name=None): :param ucfg: upload config :type ucfg: object - :param provider_name: the name of the provider to validate the settings - against + :param provider_name: the name of the provider to validate the settings against :type provider_name: str :param settings: the settings to validate :type settings: dict diff --git a/src/lifted/queue.py b/src/lifted/queue.py index 8f12537e..aa398fc7 100644 --- a/src/lifted/queue.py +++ b/src/lifted/queue.py @@ -91,11 +91,9 @@ def get_upload(ucfg, uuid, ignore_missing=False, ignore_corrupt=False): :type ucfg: object :param uuid: UUID of the upload to get :type uuid: str - :param ignore_missing: if True, don't raise a RuntimeError when the - specified upload is missing, instead just return None + :param ignore_missing: if True, don't raise a RuntimeError when the specified upload is missing, instead just return None :type ignore_missing: bool - :param ignore_corrupt: if True, don't raise a RuntimeError when the - specified upload could not be deserialized, instead just return None + :param ignore_corrupt: if True, don't raise a RuntimeError when the specified upload could not be deserialized, instead just return None :type ignore_corrupt: bool :returns: the upload object or None :rtype: Upload or None @@ -146,13 +144,11 @@ def create_upload(ucfg, provider_name, image_name, settings): :param ucfg: upload config :type ucfg: object - :param provider_name: the name of the cloud provider to upload to, e.g. - "azure" + :param provider_name: the name of the cloud provider to upload to, e.g. "azure" :type provider_name: str :param image_name: what to name the image in the cloud :type image_name: str - :param settings: settings to pass to the upload, specific to the cloud - provider + :param settings: settings to pass to the upload, specific to the cloud provider :type settings: dict :returns: the created upload object :rtype: Upload diff --git a/src/pylorax/api/v1.py b/src/pylorax/api/v1.py index 07a0461c..7b858db3 100644 --- a/src/pylorax/api/v1.py +++ b/src/pylorax/api/v1.py @@ -832,7 +832,7 @@ def v1_upload_log(upload_uuid): { "status": true, "upload_id": "b637c411-9d9d-4279-b067-6c8d38e3b211", - "log": "\n __________________\r\n< PLAY [localhost] >..." + "log": "< PLAY [localhost] >..." } """ if VALID_API_STRING.match(upload_uuid) is None: