adding notes about dealing with exceptions in the client

Change-Id: I661b10414e0281bc695236bb32f985b0ef5b7600
This commit is contained in:
Joe Heck
2013-04-03 09:44:20 -07:00
parent 3ce7017c7a
commit b8d3788bf0
2 changed files with 10 additions and 0 deletions

View File

@@ -75,3 +75,9 @@ Docstrings
:returns: description of the return value
"""
Exceptions
----------
When dealing with exceptions from underlying libraries, translate those
exceptions to an instance or subclass of ClientException.

View File

@@ -29,6 +29,10 @@ You create a valid ``keystoneclient.v2_0.client.Client`` object by passing
authentication data to the constructor. Authentication and examples of common
tasks are provided below.
You can generally expect that when the client needs to propogate an exception
it will raise an instance of subclass of
``keystoneclient.exceptions.ClientException``
Authenticating
==============