Repository: incubator-airflow Updated Branches: refs/heads/master bb287ecf5 -> f64224204
[AIRFLOW-2212] Fix ungenerated sensor API reference Some community-contributed sensors are missing from API reference. This PR fixes docs/code.rst to refer to collect sensor classes. Closes #3125 from sekikn/AIRFLOW-2212 Project: http://git-wip-us.apache.org/repos/asf/incubator-airflow/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-airflow/commit/f6422420 Tree: http://git-wip-us.apache.org/repos/asf/incubator-airflow/tree/f6422420 Diff: http://git-wip-us.apache.org/repos/asf/incubator-airflow/diff/f6422420 Branch: refs/heads/master Commit: f642242047f3db80d9427a085fc5a8eeff3a7e0f Parents: bb287ec Author: Kengo Seki <sek...@apache.org> Authored: Mon Mar 19 22:55:51 2018 +0100 Committer: Fokko Driesprong <fokkodriespr...@godatadriven.com> Committed: Mon Mar 19 22:55:51 2018 +0100 ---------------------------------------------------------------------- airflow/contrib/sensors/hdfs_sensor.py | 2 ++ docs/code.rst | 10 +++++++--- 2 files changed, 9 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-airflow/blob/f6422420/airflow/contrib/sensors/hdfs_sensor.py ---------------------------------------------------------------------- diff --git a/airflow/contrib/sensors/hdfs_sensor.py b/airflow/contrib/sensors/hdfs_sensor.py index 1ff395f..7028cf9 100644 --- a/airflow/contrib/sensors/hdfs_sensor.py +++ b/airflow/contrib/sensors/hdfs_sensor.py @@ -25,6 +25,7 @@ class HdfsSensorRegex(HdfsSensor): def poke(self, context): """ poke matching files in a directory with self.regex + :return: Bool depending on the search criteria """ sb = self.hook(self.hdfs_conn_id).get_conn() @@ -53,6 +54,7 @@ class HdfsSensorFolder(HdfsSensor): def poke(self, context): """ poke for a non empty directory + :return: Bool depending on the search criteria """ sb = self.hook(self.hdfs_conn_id).get_conn() http://git-wip-us.apache.org/repos/asf/incubator-airflow/blob/f6422420/docs/code.rst ---------------------------------------------------------------------- diff --git a/docs/code.rst b/docs/code.rst index c20ff7b..e614be5 100644 --- a/docs/code.rst +++ b/docs/code.rst @@ -184,9 +184,13 @@ Sensors .. autoclass:: airflow.contrib.sensors.emr_job_flow_sensor.EmrJobFlowSensor .. autoclass:: airflow.contrib.sensors.emr_step_sensor.EmrStepSensor .. autoclass:: airflow.contrib.sensors.file_sensor.FileSensor -.. autoclass:: airflow.contrib.sensors.ftp_sensor.FtpSensor -.. autoclass:: airflow.contrib.sensors.gcs_sensor.GcsSensor -.. autoclass:: airflow.contrib.sensors.hdfs_sensor.HdfsSensor +.. autoclass:: airflow.contrib.sensors.ftp_sensor.FTPSensor +.. autoclass:: airflow.contrib.sensors.ftp_sensor.FTPSSensor +.. autoclass:: airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageObjectSensor +.. autoclass:: airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageObjectUpdatedSensor +.. autoclass:: airflow.contrib.sensors.gcs_sensor.GoogleCloudStoragePrefixSensor +.. autoclass:: airflow.contrib.sensors.hdfs_sensor.HdfsSensorFolder +.. autoclass:: airflow.contrib.sensors.hdfs_sensor.HdfsSensorRegex .. autoclass:: airflow.contrib.sensors.jira_sensor.JiraSensor .. autoclass:: airflow.contrib.sensors.pubsub_sensor.PubSubPullSensor .. autoclass:: airflow.contrib.sensors.qubole_sensor.QuboleSensor
