openstack
/
ironic
Code Issues Proposed changes

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
This commit is contained in:
klyang 2017-03-28 09:54:48 +08:00
parent 8aec5fb6a5
commit 686901c3bd
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ironic/common/images.py
View File

@ -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')