Cinder

docs: many docstring warnings and errors on build

Bug #1557047 reported by Danny Al-Gaaf
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Cinder
Fix Released
Low
Danny Al-Gaaf

Bug Description

There is a long list of docstring warnings for code documentation and rst files during the build. e.g.:

/develop/OpenStack/cinder/cinder/db/api.py:docstring of cinder.db.api.conditional_update:18: ERROR: Unexpected indentation.
/develop/OpenStack/cinder/cinder/db/api.py:docstring of cinder.db.api.conditional_update:19: WARNING: Block quote ends without a blank line; unexpected unindent.
/develop/OpenStack/cinder/cinder/db/api.py:docstring of cinder.db.api.conditional_update:28: ERROR: Unexpected indentation.
/develop/OpenStack/cinder/cinder/db/api.py:docstring of cinder.db.api.conditional_update:30: WARNING: Definition list ends without a blank line; unexpected unindent.
/develop/OpenStack/cinder/cinder/db/api.py:docstring of cinder.db.api.conditional_update:34: ERROR: Unexpected indentation.
/develop/OpenStack/cinder/cinder/db/api.py:docstring of cinder.db.api.conditional_update:35: WARNING: Block quote ends without a blank line; unexpected unindent.
/develop/OpenStack/cinder/cinder/db/api.py:docstring of cinder.db.api.conditional_update:48: WARNING: Field list ends without a blank line; unexpected unindent.

A full log will be attached

Revision history for this message
Danny Al-Gaaf (danny-al-gaaf) wrote :
Changed in cinder:
assignee: nobody → Danny Al-Gaaf (danny-al-gaaf)
Revision history for this message
Danny Al-Gaaf (danny-al-gaaf) wrote :

I will work on this one.

Eric Harney (eharney)
Changed in cinder:
importance: Undecided → Low
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to cinder (master)

Fix proposed to branch: master
Review: https://review.openstack.org/293050

Changed in cinder:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to cinder (master)

Reviewed: https://review.openstack.org/293050
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=1323339d3301de6410837bf9ef1c52042097f8ec
Submitter: Jenkins
Branch: master

commit 1323339d3301de6410837bf9ef1c52042097f8ec
Author: Danny Al-Gaaf <email address hidden>
Date: Mon Mar 14 23:09:12 2016 +0100

    Fix doc and source documentation errors and warning

    Solve warnings and errors from build_sphinx. Fix rst doc files
    and source code docstring issues.

    Closes-Bug: #1557047

    Change-Id: Ib59df2681c98716c786ff0edf6d7cfcc3e8fe5ec
    Signed-off-by: Danny Al-Gaaf <email address hidden>

Changed in cinder:
status: In Progress → Fix Released
Revision history for this message
Doug Hellmann (doug-hellmann) wrote : Fix included in openstack/cinder 9.0.0.0b1

This issue was fixed in the openstack/cinder 9.0.0.0b1 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.