diff options
author | kairat_kushaev <kkushaev@mirantis.com> | 2016-02-01 12:43:42 +0300 |
---|---|---|
committer | kairat_kushaev <kkushaev@mirantis.com> | 2016-02-01 13:15:01 +0300 |
commit | 29fcefc67ad2005bd2ef4615d63c0e4876ffd794 (patch) | |
tree | fd6c0b1cbc5043aabb43d241ec48a844cf662bca | |
parent | 185255a5c4bc586a1b36289cb783035cf72f42f4 (diff) | |
download | python-glanceclient-29fcefc67ad2005bd2ef4615d63c0e4876ffd794.tar.gz |
Fix warnings in glanceclient README
README.rst file for functional tests and glanceclient itself
raises some warnings when passing these docs through REST
validator and build the doc:
- Need additional empty line to provide correct indent in
cloud.yaml example
- Title should be with the same length as overline.
The patch fixes these warnings.
Change-Id: I2e2ef6f838ee639d1a88256b6e321181a62cc76b
-rw-r--r-- | README.rst | 2 | ||||
-rw-r--r-- | glanceclient/tests/functional/README.rst | 15 |
2 files changed, 11 insertions, 6 deletions
@@ -1,5 +1,5 @@ Python bindings to the OpenStack Images API -============================================= +=========================================== .. image:: https://img.shields.io/pypi/v/python-glanceclient.svg :target: https://pypi.python.org/pypi/python-glanceclient/ diff --git a/glanceclient/tests/functional/README.rst b/glanceclient/tests/functional/README.rst index 123b82d..ff63950 100644 --- a/glanceclient/tests/functional/README.rst +++ b/glanceclient/tests/functional/README.rst @@ -1,9 +1,9 @@ -===================================== +====================================== python-glanceclient functional testing -===================================== +====================================== Idea ------- +---- Run real client/server requests in the gate to catch issues which are difficult to catch with a purely unit test approach. @@ -13,7 +13,7 @@ the gate. Testing Theory ----------------- +-------------- Since python-glanceclient has two uses, CLI and python API, we should have two sets of functional tests. CLI and python API. The python API @@ -23,7 +23,7 @@ would involve a non trivial amount of work. Functional Test Guidelines ---------------------------- +-------------------------- The functional tests require: @@ -39,10 +39,15 @@ with the following format: devstack-admin: auth: auth_url: http://10.0.0.1:35357/v2.0 + password: example + project_name: admin + username: admin + identity_api_version: '2.0' + region_name: RegionOne and copy it to ~/.config/openstack/clouds.yaml |