Address Stewart's comments (GoogleCloudPlatform#1591)

Ace Nassri · web-flow · commit e118431fc31e · 2018-08-09T14:23:42.000-07:00
* Address Stewart's comments

* Fix incorrect comments

Change-Id: Id393e074866ca12e84fa2ccaf43e4a4b25f9a0c9

* Fix lint

Change-Id: Ib2ef96d76573392af62e6ccb151b844787d9246b
diff --git a/functions/helloworld/main.py b/functions/helloworld/main.py
@@ -36,7 +36,7 @@ def hello_background(data, context):
     Args:
          data (dict): The dictionary with data specific to the given event.
          context (google.cloud.functions.Context): The Cloud Functions event
-         context.
+         metadata.
     """
     if data and 'name' in data:
         name = data['name']
@@ -72,7 +72,7 @@ def hello_pubsub(data, context):
     Args:
          data (dict): The dictionary with data specific to this type of event.
          context (google.cloud.functions.Context): The Cloud Functions event
-         context.
+         metadata.
     """
     import base64
 
@@ -90,7 +90,7 @@ def hello_gcs(data, context):
     Args:
          data (dict): The dictionary with data specific to this type of event.
          context (google.cloud.functions.Context): The Cloud Functions
-         event context.
+         event metadata.
     """
     print("File: {}.".format(data['objectId']))
 # [END functions_helloworld_storage]
@@ -162,8 +162,7 @@ def hello_error_2(request):
     logging.error(RuntimeError('I failed you (logging.error)'))
     sys.stderr.write('I failed you (sys.stderr.write)\n')
 
-    # WILL NOT be reported to Stackdriver Error Reporting, but will show up
-    # in request logs (as a 500 response)
+    # This WILL be reported to Stackdriver Error Reporting
     from flask import abort
     return abort(500)
     # [END functions_helloworld_error]
diff --git a/functions/tips/main.py b/functions/tips/main.py
@@ -88,8 +88,18 @@ def connection_pooling(request):
 
 
 # [START functions_tips_infinite_retries]
-def avoid_infinite_retries(event, context):
-    timestamp = event.timestamp
+def avoid_infinite_retries(data, context):
+    """Background Cloud Function that only executes within a certain
+    time period after the triggering event.
+
+    Args:
+        data (dict): The event payload.
+        context (google.cloud.functions.Context): The event metadata.
+    Returns:
+        None; output is written to Stackdriver Logging
+    """
+
+    timestamp = data.timestamp
 
     event_time = parser.parse(timestamp)
     event_age = (datetime.now() - event_time).total_seconds() * 1000
@@ -106,11 +116,20 @@ def avoid_infinite_retries(event, context):
 
 
 # [START functions_tips_retry]
-def retry_or_not(event, context):
+def retry_or_not(data, context):
+    """Background Cloud Function that demonstrates how to toggle retries.
+
+    Args:
+        data (dict): The event payload.
+        context (google.cloud.functions.Context): The event metadata.
+    Returns:
+        None; output is written to Stackdriver Logging
+    """
+
     from google import cloud
     error_client = cloud.error_reporting.Client()
 
-    if event.data.get('retry'):
+    if data.data.get('retry'):
         try_again = True
     else:
         try_again = False
