yahoo-eng-team team mailing list archive

Thread
Date

[Bug 1565005] [NEW] Warnings when docs are generating

To: yahoo-eng-team@xxxxxxxxxxxxxxxxxxx
From: Tom Cocozzello <tjcocozz@xxxxxxxxxx>
Date: Fri, 01 Apr 2016 16:57:48 -0000
Reply-to: Bug 1565005 <1565005@xxxxxxxxxxxxxxxxxx>
Sender: bounces@xxxxxxxxxxxxx

Public bug reported:

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.

** Affects: glance
Importance: Undecided
Assignee: Tom Cocozzello (tjcocozz)
Status: New

** Changed in: glance
Assignee: (unassigned) => Tom Cocozzello (tjcocozz)

** Description changed:

- Looks like there are a few warnings when the docs are generating on master. Until this warnerrors change is merged
+ 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.

--
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:
New

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.

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

Follow ups

[Bug 1565005] Re: Warnings when docs are generating
From: OpenStack Infra, 2016-04-07