From 9eb49393ef48f08becc788fcc2a896d43ced4de2 Mon Sep 17 00:00:00 2001 From: "Juan M. Uys" Date: Thu, 1 Feb 2018 23:08:57 +0000 Subject: [PATCH 1/2] clarify that modify_ack_deadline resets the deadline to the number of seconds from now --- pubsub/google/cloud/pubsub_v1/subscriber/message.py | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/pubsub/google/cloud/pubsub_v1/subscriber/message.py b/pubsub/google/cloud/pubsub_v1/subscriber/message.py index cb27876942a0..dbd1315cfe31 100644 --- a/pubsub/google/cloud/pubsub_v1/subscriber/message.py +++ b/pubsub/google/cloud/pubsub_v1/subscriber/message.py @@ -223,18 +223,14 @@ def lease(self): ) def modify_ack_deadline(self, seconds): - """Set the deadline for acknowledgement to the given value. + """Resets the deadline for acknowledgement to the given value of + seconds from now. The default implementation handles this for you; you should not need to manually deal with setting ack deadlines. The exception case is if you are implementing your own custom subclass of :class:`~.pubsub_v1.subcriber._consumer.Consumer`. - .. note:: - This is not an extension; it *sets* the deadline to the given - number of seconds from right now. It is even possible to use this - method to make a deadline shorter. - Args: seconds (int): The number of seconds to set the lease deadline to. This should be between 0 and 600. Due to network latency, From 4af7296947d6f861e920b126a90fe381211e4546 Mon Sep 17 00:00:00 2001 From: Tres Seaver Date: Fri, 2 Feb 2018 06:59:13 -0500 Subject: [PATCH 2/2] Tweak to ensure single-line summary. --- pubsub/google/cloud/pubsub_v1/subscriber/message.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/pubsub/google/cloud/pubsub_v1/subscriber/message.py b/pubsub/google/cloud/pubsub_v1/subscriber/message.py index dbd1315cfe31..27ad9f0e7f32 100644 --- a/pubsub/google/cloud/pubsub_v1/subscriber/message.py +++ b/pubsub/google/cloud/pubsub_v1/subscriber/message.py @@ -223,8 +223,9 @@ def lease(self): ) def modify_ack_deadline(self, seconds): - """Resets the deadline for acknowledgement to the given value of - seconds from now. + """Resets the deadline for acknowledgement. + + New deadline will be the given value of seconds from now. The default implementation handles this for you; you should not need to manually deal with setting ack deadlines. The exception case is