From 686901c3bd7c1a96fe6a64e700aae655ccfa5b5b Mon Sep 17 00:00:00 2001 From: klyang Date: Tue, 28 Mar 2017 09:54:48 +0800 Subject: [PATCH] Fix some api field lists in docstrings Probably the most common format for documenting arguments is api field lists [1]. This change updates some docstrings to comply with the field lists syntax. [1] http://sphinx-doc.org/domains.html#info-field-lists Change-Id: Id3477a96eefccf826f7a07329280df1b1eaeb528 --- ironic/common/images.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ironic/common/images.py b/ironic/common/images.py index 2321c8d3a7..dd89f17ef1 100644 --- a/ironic/common/images.py +++ b/ironic/common/images.py @@ -461,7 +461,7 @@ def is_whole_disk_image(ctx, instance_info): :param ctx: an admin context :param instance_info: a node's instance info dict - :returns True for whole disk images and False for partition images + :returns: True for whole disk images and False for partition images and None on no image_source or Error. """ image_source = instance_info.get('image_source')