[GitHub] [airflow] csm10495 commented on a diff in pull request #28369: Add some extra info to taskflow sensor api docs

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

csm10495 commented on code in PR #28369:
URL: https://github.com/apache/airflow/pull/28369#discussion_r1049241017


##########
docs/apache-airflow/tutorial/taskflow.rst:
##########
@@ -365,7 +365,11 @@ You can apply the ``@task.sensor`` decorator to convert a regular Python functio
 BaseSensorOperator class. The Python function implements the poke logic and returns an instance of
 the ``PokeReturnValue`` class as the ``poke()`` method in the BaseSensorOperator does. The ``PokeReturnValue`` is
 a new feature in Airflow 2.3 that allows a sensor operator to push an XCom value as described in
-section "Having sensors return XOM values" of :doc:`apache-airflow-providers:howto/create-update-providers`.
+section "Having sensors return XCOM values" of :doc:`apache-airflow-providers:howto/create-update-providers`.
+
+Alternatively in cases where the sensor doesn't need to push XCOM values:  both ``poke()`` and the wrapped
+function can return a boolean-like value where ``True`` designates the sensor's operation as complete and
+``False`` designates the sensor's operation as incomplete.

Review Comment:
   I believe on older airflows this was the expectation for sensors. Even the new object has __bool__ to maintain that compatibility. Therefore I think it is useful to note and document.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org