Commit 402ff455 authored by Michael Hanselmann's avatar Michael Hanselmann

errors: Show error descriptions in API documentation

Comments with a colon after the hash sign (“#:”) show up in the
epydoc output.
Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
Reviewed-by: default avatarIustin Pop <iustin@google.com>
parent 4d829f55
......@@ -24,23 +24,31 @@
# OpPrereqError failure types
# resolver errors
#: Resolver errors
ECODE_RESOLVER = "resolver_error"
# not enough resources (iallocator failure, disk space, memory, etc.)
#: Not enough resources (iallocator failure, disk space, memory, etc.)
ECODE_NORES = "insufficient_resources"
# wrong arguments (at syntax level)
#: Wrong arguments (at syntax level)
ECODE_INVAL = "wrong_input"
# wrong entity state
#: Wrong entity state
ECODE_STATE = "wrong_state"
# entity not found
#: Entity not found
ECODE_NOENT = "unknown_entity"
# entity already exists
#: Entity already exists
ECODE_EXISTS = "already_exists"
# resource not unique (e.g. MAC or IP duplication)
#: Resource not unique (e.g. MAC or IP duplication)
ECODE_NOTUNIQUE = "resource_not_unique"
# internal cluster error
#: Internal cluster error
ECODE_FAULT = "internal_error"
# environment error (e.g. node disk error)
#: Environment error (e.g. node disk error)
ECODE_ENVIRON = "environment_error"
#: List of all failure types
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment