[GitHub] kaxil commented on a change in pull request #3946: [AIRFLOW-3062] Add Qubole in integration docs

[GitBox <gi...@apache.org>]

kaxil commented on a change in pull request #3946: [AIRFLOW-3062] Add Qubole in integration docs
URL: https://github.com/apache/incubator-airflow/pull/3946#discussion_r221424279
 
 

 ##########
 File path: airflow/contrib/sensors/qubole_sensor.py
 ##########
 @@ -75,13 +67,45 @@ def poke(self, context):
 
 
 class QuboleFileSensor(QuboleSensor):
+    """
+    Wait for a file or folder to be present in cloud storage
+    and check for its presence via QDS APIs
+
+    :param qubole_conn_id: Connection id which consists of qds auth_token
+    :type qubole_conn_id: string
+    :param data: a JSON object containing payload, whose presence needs to be checked
+        Check this `example <https://github.com/apache/incubator-airflow/blob/master\
+        /airflow/contrib/example_dags/example_qubole_sensor.py>`_ for sample payload
+        structure.
+    :type data: a JSON object
+
+    .. note:: Both ``data`` and ``qubole_conn_id`` fields support templating. You can
+        also use ``.txt`` files for template-driven use cases.
+    """
+
     @apply_defaults
     def __init__(self, *args, **kwargs):
         self.sensor_class = FileSensor
         super(QuboleFileSensor, self).__init__(*args, **kwargs)
 
 
 class QubolePartitionSensor(QuboleSensor):
+    """
+    Wait for a Hive partition to show up in QHS (Qubole Hive Service)
+    and check for its presence via QDS APIs
+
+    :param qubole_conn_id: Connection id which consists of qds auth_token
+    :type qubole_conn_id: string
 
 Review comment:
   `str` instead of `string`

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services