openstack/python-ceilometerclient
Code Issues Proposed changes

fix client docstring

Browse Source 
* fix broken docstring in ceilometerclient.client
* remove non-existent `release` index
* remove duplicated reference generation in ext/gen_ref.py

Change-Id: Iad8c527e61628a406d5dd84adac875190b994fac
Closes-Bug: #1440629
This commit is contained in:
ZhiQiang Fan 2015-04-06 10:04:23 +08:00
parent c40d67cf97
commit 2ea94891ea
3 changed files with 2 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ceilometerclient/client.py
View File

@ -282,7 +282,9 @@ def get_client(version, **kwargs):
* ceilometer_url: (DEPRECATED) Ceilometer API endpoint, * ceilometer_url: (DEPRECATED) Ceilometer API endpoint,
use os_endpoint instead use os_endpoint instead
* os_endpoint: Ceilometer API endpoint * os_endpoint: Ceilometer API endpoint
or: or:
* os_username: name of user * os_username: name of user
* os_password: user's password * os_password: user's password
* os_user_id: user's id * os_user_id: user's id

5
doc/ext/gen_ref.py
View File

@ -52,8 +52,3 @@ def gen_ref(ver, title, names):
% {"title": name.capitalize(), % {"title": name.capitalize(),
"signs": "=" * len(name), "signs": "=" * len(name),
"pkg": pkg, "name": name}) "pkg": pkg, "name": name})
gen_ref("", "Client Reference", ["client", "exc"])
gen_ref("v1", "Version 1 API Reference",
["stacks", "resources", "events", "actions",
"software_configs", "software_deployments"])

1
doc/source/index.rst
View File

@ -24,7 +24,6 @@ Contents:
ref/index ref/index
ref/v1/index ref/v1/index
ref/v2/index ref/v2/index
releases
Contributing Contributing
============ ============