From 402ff4559a35e646650fcaec8092bf224c2c8740 Mon Sep 17 00:00:00 2001 From: Michael Hanselmann Date: Tue, 4 Dec 2012 16:06:23 +0100 Subject: [PATCH 1/1] errors: Show error descriptions in API documentation MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Comments with a colon after the hash sign (“#:”) show up in the epydoc output. Signed-off-by: Michael Hanselmann Reviewed-by: Iustin Pop --- lib/errors.py | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/lib/errors.py b/lib/errors.py index d416653..3d2a33d 100644 --- a/lib/errors.py +++ b/lib/errors.py @@ -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 -- 1.7.10.4