openstack
/
cinder
Code Issues Proposed changes

[DOC BLD FIX] Correct :returns: in db/api.py 

The docstring for conditional_update had ":returns" instead
of ":returns:" which was causing a Sphinx warning to be
generated and caused the documentation to be improperly
rendered.

This patch corrects the formatting.

Change-Id: I7388904593572cf61194ca1e7cabf5e7a461f3b0
This commit is contained in:
Jay S. Bryant 2017-07-14 15:23:35 -05:00
parent 817f34ce5d
commit 2ff517d049
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/db/api.py
View File

@ -1858,7 +1858,7 @@ def conditional_update(context, model, values, expected_values, filters=(),
equivalent to read_deleted.
:param project_only: Should the query be limited to context's project.
:param order: Specific order of fields in which to update the values
:returns number of db rows that were updated.
:returns: Number of db rows that were updated.
"""
return IMPL.conditional_update(context, model, values, expected_values,
filters, include_deleted, project_only,