openstack
/
python-glanceclient
Code Issues Proposed changes

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
This commit is contained in:
kairat_kushaev 2016-02-01 12:43:42 +03:00
parent 185255a5c4
commit 29fcefc67a
2 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.rst
View File

@ -1,5 +1,5 @@
Python bindings to the OpenStack Images API Python bindings to the OpenStack Images API
============================================= ===========================================
.. image:: https://img.shields.io/pypi/v/python-glanceclient.svg .. image:: https://img.shields.io/pypi/v/python-glanceclient.svg
:target: https://pypi.python.org/pypi/python-glanceclient/ :target: https://pypi.python.org/pypi/python-glanceclient/

15
glanceclient/tests/functional/README.rst
View File

@ -1,9 +1,9 @@
===================================== ======================================
python-glanceclient functional testing python-glanceclient functional testing
===================================== ======================================
Idea Idea
------ ----
Run real client/server requests in the gate to catch issues which Run real client/server requests in the gate to catch issues which
are difficult to catch with a purely unit test approach. are difficult to catch with a purely unit test approach.
@ -13,7 +13,7 @@ the gate.
Testing Theory Testing Theory
---------------- --------------
Since python-glanceclient has two uses, CLI and python API, we should 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 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 Functional Test Guidelines
--------------------------- --------------------------
The functional tests require: The functional tests require:
@ -39,10 +39,15 @@ with the following format:
devstack-admin: devstack-admin:
auth: auth:
auth_url: http://10.0.0.1:35357/v2.0 auth_url: http://10.0.0.1:35357/v2.0
password: example password: example
project_name: admin project_name: admin
username: admin username: admin
identity_api_version: '2.0' identity_api_version: '2.0'
region_name: RegionOne region_name: RegionOne
and copy it to ~/.config/openstack/clouds.yaml and copy it to ~/.config/openstack/clouds.yaml