promenade/docs/source/exceptions.rst
Krysta 31c2fc8346 Documentation for exceptions
Adds documentation for promenade exceptions.

Change-Id: I26f817f7294df686eeb6f29099dfe69e0b64bbea
2018-02-23 10:35:18 -05:00

42 lines
1.2 KiB
ReStructuredText

..
Copyright 2017 AT&T Intellectual Property.
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Promenade Exceptions
====================
.. list-table::
:widths: 5 50
:header-rows: 1
* - Exception Name
- Description
* - ApiError
- .. autoexception:: promenade.exceptions.ApiError
:members:
:show-inheritance:
:undoc-members:
* - InvalidFormatError
- .. autoexception:: promenade.exceptions.InvalidFormatError
:members:
:show-inheritance:
:undoc-members:
* - ValidationException
- .. autoexception:: promenade.exceptions.ValidationException
:members:
:show-inheritance:
:undoc-members: