zuul
/
zuul
Code Issues Proposed changes

Clarify TriggerInterface documentation 

There is no "Trigger" class, but there are objects that should
derive from the BaseTrigger abstract class.

Change-Id: I4702b719770215b420001bb8a3b0bc42f7437f9a
This commit is contained in:
David Shrewsbury 2017-04-05 11:30:16 -04:00
parent 95ec6202af
commit adbab664ce
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
zuul/driver/__init__.py
View File

@ -117,25 +117,28 @@ class ConnectionInterface(object):
class TriggerInterface(object):
"""The trigger interface.
A driver which is able to supply a Trigger should implement this
A driver which is able to supply a trigger should implement this
interface.
"""
@abc.abstractmethod
def getTrigger(self, connection, config=None):
"""Create and return a new Trigger object.
"""Create and return a new trigger object.
This method is required by the interface.
The trigger object returned should inherit from the
:py:class:`~zuul.trigger.BaseTrigger` class.
:arg Connection connection: The Connection object associated
with the trigger (as previously returned by getConnection)
or None.
:arg dict config: The configuration information supplied along
with the trigger in the layout.
:returns: A new Trigger object.
:rtype: Trigger
:returns: A new trigger object.
:rtype: :py:class:`~zuul.trigger.BaseTrigger`
"""
pass