From 41e9d98ba629b8a4aca765ab6b87377c56600532 Mon Sep 17 00:00:00 2001 From: Colton Myers Date: Mon, 18 Nov 2013 16:41:39 -0700 Subject: [PATCH] Update api.get_event docs to match SaltEvent.get_event Ref #8524 --- salt/client/api.py | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/salt/client/api.py b/salt/client/api.py index 57cd124117..765c070edc 100644 --- a/salt/client/api.py +++ b/salt/client/api.py @@ -280,13 +280,11 @@ class APIClient(object): def get_event(self, wait=0.25, tag='', full=False): ''' - Returns next available event with tag tag from event bus - If any within wait seconds + Get a single salt event. + If no events are available, then block for up to ``wait`` seconds. + Return the event if it matches the tag (or ``tag`` is empty) Otherwise return None - If tag is empty then return events for all tags - If full then add tag field to returned data - If wait is 0 then block forever or until next event becomes available. ''' return (self.event.get_event(wait=wait, tag=tag, full=full))