← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1565005] Re: Warnings when docs are generating

 

Reviewed:  https://review.openstack.org/300602
Committed: https://git.openstack.org/cgit/openstack/glance/commit/?id=ff675437f3a92cbd8cc4f5c79e7bb60c73bd4a91
Submitter: Jenkins
Branch:    master

commit ff675437f3a92cbd8cc4f5c79e7bb60c73bd4a91
Author: Tom Cocozzello <tjcocozz@xxxxxxxxxx>
Date:   Fri Apr 1 13:20:18 2016 -0500

    Fix doc-strings warnings and errors
    
    Fixing doc-string warnings in preparation for
    this patch [0] to merge and allow the gate
    to show problems in doc-strings.
    
    [0]: https://review.openstack.org/#/c/229951
    
    Closes-Bug: #1565005
    Change-Id: I1d1eb214026a963f7ebe5ccf60fa1ae31f54c579


** Changed in: glance
       Status: In Progress => Fix Released

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to Glance.
https://bugs.launchpad.net/bugs/1565005

Title:
  Warnings when docs are generating

Status in Glance:
  Fix Released

Bug description:
  Looks like there are a few warnings when the docs are generating on master. Until this warnerrors change is merged, https://review.openstack.org/#/c/229951,
  we have to manually run 'tox -e docs' to see if patches are introducing new problems with the doc strings.  Once that patch is merged it will show at the gate.

  Bellow are the warnings i am seeing.

  /home/tom/Documents/glance/glance/location.py:docstring of glance.location.StoreLocations:3: WARNING: Literal block expected; none found.
  /home/tom/Documents/glance/glance/tests/functional/v1/test_api.py:docstring of glance.tests.functional.v1.test_api.TestApi.test_download_non_exists_image_raises_http_forbidden:3: WARNING: Literal block expected; none found.
  /home/tom/Documents/glance/glance/tests/functional/v1/test_api.py:docstring of glance.tests.functional.v1.test_api.TestApi.test_download_non_exists_image_raises_http_forbidden:14: ERROR: Unexpected indentation.
  /home/tom/Documents/glance/glance/tests/unit/test_glare_plugin_loader.py:docstring of glance.tests.unit.test_glare_plugin_loader.TestArtifactsLoader.test_check_function:6: WARNING: Bullet list ends without a blank line; unexpected unindent.

To manage notifications about this bug go to:
https://bugs.launchpad.net/glance/+bug/1565005/+subscriptions


References