← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1556818] Re: docstring warnings in glance

 

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

commit adfc7e5a3fef26d3781d5aa19f5eaa86ac09d033
Author: Tom Cocozzello <tjcocozz@xxxxxxxxxx>
Date:   Wed Mar 9 13:53:37 2016 -0600

    fix docstring warnings and errors
    
    There are many warnings and errors that occur when the docs are
    generated.
    
    Co-Author-By: Danny Al-Gaaf <danny.al-gaaf@xxxxxxxxx>
    Closes-Bug: 1556818
    Change-Id: Ifebeb3904f136a56bd6fe6877220b279a1f98354


** 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/1556818

Title:
  docstring warnings in glance

Status in Glance:
  Fix Released

Bug description:
  Building the glance docs produces some docstring warnings:

  
  /develop/OpenStack/glance/glance/location.py:docstring of glance.location.StoreLocations:4: ERROR: Unexpected indentation.
  /develop/OpenStack/glance/glance/api/v1/images.py:docstring of glance.api.v1.images.Controller.detail:4: WARNING: Field list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/api/v1/images.py:docstring of glance.api.v1.images.Controller.index:11: WARNING: Field list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/api/v1/images.py:docstring of glance.api.v1.images.Controller.meta:6: WARNING: Field list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/api/v1/members.py:docstring of glance.api.v1.members.Controller.index:6: WARNING: Field list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/api/v1/members.py:docstring of glance.api.v1.members.Controller.index_shared_images:5: WARNING: Field list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/api/v2/image_members.py:docstring of glance.api.v2.image_members.ImageMembersController.index:6: WARNING: Field list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/api/v2/image_members.py:docstring of glance.api.v2.image_members.ImageMembersController.show:5: WARNING: Field list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/async/flows/ovf_process.py:docstring of glance.async.flows.ovf_process.OVAImageExtractor.extract:7: ERROR: Unexpected indentation.
  /develop/OpenStack/glance/glance/async/flows/ovf_process.py:docstring of glance.async.flows.ovf_process.OVAImageExtractor.extract:8: WARNING: Block quote ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/common/rpc.py:docstring of glance.common.rpc.Controller:9: WARNING: Definition list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/common/rpc.py:docstring of glance.common.rpc.Controller:15: WARNING: Field list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/common/rpc.py:docstring of glance.common.rpc.Controller.register:5: WARNING: Field list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/common/rpc.py:docstring of glance.common.rpc.RPCClient.bulk_request:4: WARNING: Field list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/common/rpc.py:docstring of glance.common.rpc.RPCClient.bulk_request:9: WARNING: Definition list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/registry/api/v1/images.py:docstring of glance.registry.api.v1.images.Controller.detail:4: WARNING: Field list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/registry/api/v1/images.py:docstring of glance.registry.api.v1.images.Controller.index:4: WARNING: Field list ends without a blank line; unexpected unindent.
  /develop/OpenStack/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.
  /develop/OpenStack/glance/glance/tests/integration/legacy_functional/test_v1_api.py:docstring of glance.tests.integration.legacy_functional.test_v1_api.TestApi.test_queued_process_flow:9: ERROR: Unexpected indentation.
  /develop/OpenStack/glance/glance/tests/integration/legacy_functional/test_v1_api.py:docstring of glance.tests.integration.legacy_functional.test_v1_api.TestApi.test_queued_process_flow:10: WARNING: Block quote ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/tests/integration/legacy_functional/test_v1_api.py:docstring of glance.tests.integration.legacy_functional.test_v1_api.TestApi.test_queued_process_flow:11: WARNING: Bullet list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/glance/tests/unit/test_glare_plugin_loader.py:docstring of glance.tests.unit.test_glare_plugin_loader.TestArtifactsLoader.test_check_function:3: ERROR: Unexpected indentation.
  /develop/OpenStack/glance/doc/source/architecture.rst:52: WARNING: Bullet list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/doc/source/architecture.rst:55: WARNING: Bullet list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/doc/source/architecture.rst:59: WARNING: Bullet list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/doc/source/architecture.rst:62: WARNING: Bullet list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/doc/source/authentication.rst:60: ERROR: Unknown target name: "documentation".
  /develop/OpenStack/glance/doc/source/configuring.rst:1720: WARNING: Inline emphasis start-string without end-string.
  /develop/OpenStack/glance/doc/source/contributing/blueprints.rst:58: WARNING: Bullet list ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/doc/source/contributing/blueprints.rst:59: WARNING: Explicit markup ends without a blank line; unexpected unindent.
  /develop/OpenStack/glance/doc/source/contributing/blueprints.rst:2: WARNING: Duplicate explicit target name: "new rfe's".
  /develop/OpenStack/glance/doc/source/contributing/blueprints.rst:2: WARNING: Duplicate explicit target name: "new rfe's".

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


References