adding function docstring for new methods

twilio-labs · Jul 22, 2021 · 50b2d14 · 50b2d14
1 parent a9c4b05
commit 50b2d14
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/tap_zendesk/__init__.py b/tap_zendesk/__init__.py
@@ -84,6 +84,7 @@ def get_abs_path(path):
 
 
 def get_side_load_schemas(sideload_objects, stream):
+    """Returns the updated schema after adding side load objects to schema dict"""
     stream_schema = stream.schema.to_dict()
     for sideload_object in sideload_objects:
         if sideload_object in SIDELOAD_OBJECTS[stream.tap_stream_id]:

diff --git a/tap_zendesk/streams.py b/tap_zendesk/streams.py
@@ -29,6 +29,7 @@
 DEFAULT_SEARCH_WINDOW_SIZE = (60 * 60 * 24) * 30 # defined in seconds, default to a month (30 days)
 
 def get_sideload_objects(stream):
+    """Returns the value of sideload-objects from metadata, returns None if no values are present"""
     return metadata.to_map(stream.metadata).get((), {}).get('sideload-objects')
 
 def get_abs_path(path):