openstack/deb-cinder
Code Issues Proposed changes

[DOC BLD FIX] Remove todo:: directive from volume_driver

Browse Source 
There was a '.. todo::' directive in cinder.interface.volume_driver
which is not a legitimate directive.  This was causing sphinx to
throw a warning.

This patch changes the format of the todo to avoid the warning.

Change-Id: I540b21053642409ef072ca51a03f95773ac5202c
This commit is contained in:
Jay S. Bryant 2017-07-17 18:09:40 -05:00
parent f6a608fd5d
commit abab90d331
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cinder/interface/volume_driver.py
View File

@ -148,7 +148,7 @@ class VolumeDriverCore(base.CinderInterface):
It should not export a LUN or actually make this storage available for
use, this is done in a later call.
.. todo:: Add example data structure of volume object (smcginnis).
TODO(smcginnis): Add example data structure of volume object.
:param volume: Volume object containing specifics to create.
:returns: (Optional) dict of database updates for the new volume.