From ffbec05c6321e44e859f6091458de155b5678ea0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Kadl=C4=8D=C3=ADk?= Date: Thu, 23 Mar 2017 19:56:00 +0100 Subject: [PATCH] Update CoprBuildEnd docstring --- module_build_service/messaging.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/module_build_service/messaging.py b/module_build_service/messaging.py index 0d163cb2..b4d2eb36 100644 --- a/module_build_service/messaging.py +++ b/module_build_service/messaging.py @@ -273,12 +273,18 @@ class KojiRepoChange(BaseMessage): class CoprBuildEnd(KojiBuildChange): - """ A wrapper class that transforms copr message attributes - to a KojiBuildChange message object + """ A class that inherits from KojiBuildChange to provide a message + object for a build info from Copr + + @TODO There should be a base class for CoprBuildEnd and KojiBuildChange + and conditions in the code should check for it's descendants instead of KojiBuildChange directly. + In such case this class would not have to inherit from koji class + :param msg_id: the id of the msg (e.g. 2016-SomeGUID) :param build_id: the id of the build (e.g. 264382) :param status: the new build state (see http://copr-backend.readthedocs.io/package/constants.html#backend.constants.BuildStatus ) + :param copr: the project name :param pkg: the full name of what is being built (e.g. mutt-kz-1.5.23.1-1.20150203.git.c8504a8a.fc21) :param state_reason: the optional reason as to why the state changed