almalinux/lorax
13
0
Fork 0
Code Issues Pull Requests Releases Activity

docs: Fix Sphinx errors in docstrings

Browse Source
This commit is contained in:
Brian C. Lane 2019-10-16 13:52:54 -07:00
parent a02538fdc3
commit 3fdc783850
3 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/lifted/providers.py
View File

@ -147,8 +147,7 @@ def validate_settings(ucfg, provider_name, settings, image_name=None):
:param ucfg: upload config :param ucfg: upload config
:type ucfg: object :type ucfg: object
:param provider_name: the name of the provider to validate the settings :param provider_name: the name of the provider to validate the settings against
against
:type provider_name: str :type provider_name: str
:param settings: the settings to validate :param settings: the settings to validate
:type settings: dict :type settings: dict

12
src/lifted/queue.py
View File

@ -91,11 +91,9 @@ def get_upload(ucfg, uuid, ignore_missing=False, ignore_corrupt=False):
:type ucfg: object :type ucfg: object
:param uuid: UUID of the upload to get :param uuid: UUID of the upload to get
:type uuid: str :type uuid: str
:param ignore_missing: if True, don't raise a RuntimeError when the :param ignore_missing: if True, don't raise a RuntimeError when the specified upload is missing, instead just return None
specified upload is missing, instead just return None
:type ignore_missing: bool :type ignore_missing: bool
:param ignore_corrupt: if True, don't raise a RuntimeError when the :param ignore_corrupt: if True, don't raise a RuntimeError when the specified upload could not be deserialized, instead just return None
specified upload could not be deserialized, instead just return None
:type ignore_corrupt: bool :type ignore_corrupt: bool
:returns: the upload object or None :returns: the upload object or None
:rtype: Upload or None :rtype: Upload or None
@ -146,13 +144,11 @@ def create_upload(ucfg, provider_name, image_name, settings):
:param ucfg: upload config :param ucfg: upload config
:type ucfg: object :type ucfg: object
:param provider_name: the name of the cloud provider to upload to, e.g. :param provider_name: the name of the cloud provider to upload to, e.g. "azure"
"azure"
:type provider_name: str :type provider_name: str
:param image_name: what to name the image in the cloud :param image_name: what to name the image in the cloud
:type image_name: str :type image_name: str
:param settings: settings to pass to the upload, specific to the cloud :param settings: settings to pass to the upload, specific to the cloud provider
provider
:type settings: dict :type settings: dict
:returns: the created upload object :returns: the created upload object
:rtype: Upload :rtype: Upload

2
src/pylorax/api/v1.py
View File

@ -832,7 +832,7 @@ def v1_upload_log(upload_uuid):
{ {
"status": true, "status": true,
"upload_id": "b637c411-9d9d-4279-b067-6c8d38e3b211", "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: if VALID_API_STRING.match(upload_uuid) is None: