3e1d9894e9
ARMADA-239: Documentation for validation error codes for Armada
3 of 3 commits (Inital Setup and Remaining Exceptions are in seperate commits)
-guide-exceptions.rst contains the files to include in the documentation.
-docs/.../exceptions files contains the format and content of the documenation.
-armada/exceptions files were modified in their comments in order to utilize the
sphinx-directed method.
Please Note: If the exception is not raised anywhere, it is not included in the
documentation.
Change-Id: Ie093cb3252b199bfc7fcd62284501e573d89ed8a
28 lines
952 B
Python
28 lines
952 B
Python
# Copyright 2017 The Armada Authors.
|
|
#
|
|
# 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.
|
|
|
|
from armada.exceptions import base_exception as base
|
|
|
|
|
|
class ManifestException(base.ArmadaBaseException):
|
|
"""
|
|
An exception occurred while attempting to build an Armada manifest. The
|
|
exception will return with details as to why.
|
|
|
|
**Troubleshoot:**
|
|
*Coming Soon*
|
|
"""
|
|
|
|
message = 'An error occurred while generating the manifest: %(details)s.'
|